Class: Cosmos::SimulatedTargetInterface

Inherits:
Interface show all
Defined in:
lib/cosmos/interfaces/simulated_target_interface.rb

Overview

An interface class that provides simulated telemetry and command responses

Constant Summary

Constants included from ApiShared

ApiShared::DEFAULT_TLM_POLLING_RATE

Constants included from Extract

Extract::SCANNING_REGULAR_EXPRESSION

Instance Attribute Summary

Attributes inherited from Interface

#auto_reconnect, #bytes_read, #bytes_written, #cmd_routers, #connect_on_startup, #disable_disconnect, #interfaces, #name, #num_clients, #options, #override_tlm, #packet_log_writer_pairs, #protocol_info, #raw_logger_pair, #read_count, #read_protocols, #read_queue_size, #read_raw_data, #read_raw_data_time, #reconnect_delay, #routers, #stored_packet_log_writer_pairs, #target_names, #thread, #write_count, #write_protocols, #write_queue_size, #written_raw_data, #written_raw_data_time

Instance Method Summary collapse

Methods inherited from Interface

#_normalize_tlm, #_override, #_override_tlm, #_override_tlm_raw, #_write, #add_protocol, #convert_data_to_packet, #convert_packet_to_data, #copy_to, #read_allowed?, #read_interface, #read_interface_base, #set_option, #start_raw_logging, #stop_raw_logging, #write_allowed?, #write_interface, #write_interface_base, #write_raw_allowed?

Methods included from Api

#cmd, #cmd_no_checks, #cmd_no_hazardous_check, #cmd_no_range_check, #cmd_raw, #cmd_raw_no_checks, #cmd_raw_no_hazardous_check, #cmd_raw_no_range_check, #cmd_tlm_clear_counters, #cmd_tlm_reload, #connect_interface, #connect_router, #disable_limits, #disable_limits_group, #disconnect_interface, #disconnect_router, #enable_limits, #enable_limits_group, #get_all_cmd_info, #get_all_interface_info, #get_all_packet_logger_info, #get_all_router_info, #get_all_target_info, #get_all_tlm_info, #get_background_tasks, #get_cmd_buffer, #get_cmd_cnt, #get_cmd_hazardous, #get_cmd_list, #get_cmd_log_filename, #get_cmd_param_list, #get_cmd_time, #get_cmd_value, #get_interface_info, #get_interface_names, #get_interface_targets, #get_limits, #get_limits_event, #get_limits_groups, #get_limits_set, #get_limits_sets, #get_out_of_limits, #get_output_logs_filenames, #get_overall_limits_state, #get_packet, #get_packet_data, #get_packet_logger_info, #get_packet_loggers, #get_router_info, #get_router_names, #get_saved_config, #get_screen_definition, #get_screen_list, #get_server_message, #get_server_message_log_filename, #get_server_status, #get_stale, #get_target_ignored_items, #get_target_ignored_parameters, #get_target_info, #get_target_list, #get_tlm_buffer, #get_tlm_cnt, #get_tlm_details, #get_tlm_item_list, #get_tlm_list, #get_tlm_log_filename, #get_tlm_packet, #get_tlm_values, #inject_tlm, #interface_state, #limits_enabled?, #map_target_to_interface, #normalize_tlm, #override_tlm, #override_tlm_raw, #replay_move_end, #replay_move_index, #replay_move_start, #replay_play, #replay_reverse_play, #replay_select_file, #replay_set_playback_delay, #replay_status, #replay_step_back, #replay_step_forward, #replay_stop, #router_state, #send_raw, #set_limits, #set_limits_set, #set_tlm, #set_tlm_raw, #start_background_task, #start_cmd_log, #start_logging, #start_new_server_message_log, #start_raw_logging_interface, #start_raw_logging_router, #start_tlm_log, #stop_background_task, #stop_cmd_log, #stop_logging, #stop_raw_logging_interface, #stop_raw_logging_router, #stop_tlm_log, #subscribe_limits_events, #subscribe_packet_data, #subscribe_server_messages, #tlm, #tlm_formatted, #tlm_raw, #tlm_variable, #tlm_with_units, #unsubscribe_limits_events, #unsubscribe_packet_data, #unsubscribe_server_messages

Constructor Details

#initialize(sim_target_file) ⇒ SimulatedTargetInterface

Returns a new instance of SimulatedTargetInterface.

Parameters:

  • sim_target_file (String) —

    Filename of the simulator target class



19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 19

def initialize(sim_target_file)
  super()
  @connected = false
  @initialized = false
  @count_100hz = 0
  @next_tick_time = nil
  @pending_packets = []
  @sim_target_class = Cosmos.require_class sim_target_file
  @sim_target = nil
  @write_raw_allowed = false
  @raw_logger_pair = nil
  add_protocol(OverrideProtocol, [], :READ)
end

Instance Method Details

#connect ⇒ Object

Initialize the simulated target object and “connect” to the target



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 34

def connect
  unless @initialized
    # Save the current time + 10 ms as the next expected tick time
    @next_tick_time = Time.now.sys + 0.01
    # Create Simulated Target Object
    @sim_target = @sim_target_class.new(@target_names[0])
    # Set telemetry rates
    @sim_target.set_rates

    @initialized = true
  end
  @connected = true
end

#connected? ⇒ Boolean

Returns Whether the simulated target is connected (initialized).

Returns:

  • (Boolean) —

    Whether the simulated target is connected (initialized)



49
50
51
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 49

def connected?
  @connected
end

#disconnect ⇒ Object

Disconnect from the simulator



131
132
133
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 131

def disconnect
  @connected = false
end

#raw_logger_pair=(raw_logger_pair) ⇒ Object

Raise an error because raw logging is not supported for this interface



126
127
128
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 126

def raw_logger_pair=(raw_logger_pair)
  raise "Raw logging not supported for SimulatedTargetInterface"
end

#read ⇒ Packet

Returns a simulated target packet from the simulator

Returns:

  • (Packet) —

    Returns a simulated target packet from the simulator



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 54

def read
  packet = nil
  if @connected
    packet = first_pending_packet()
    if packet
      # Support read_packet (but not read data) in protocols
      # Generic protocol use is not supported
      @read_protocols.each do |protocol|
        packet = protocol.read_packet(packet)
        return nil if packet == :DISCONNECT # Disconnect handled by thread
        break if packet == :STOP
      end
      return packet unless packet == :STOP
    end

    while true
      # Calculate time to sleep to make ticks 10ms apart
      now = Time.now.sys
      delta = @next_tick_time - now
      if delta > 0.0
        sleep(delta) # Sleep up to 10 ms
        return nil unless @connected
      elsif delta < -1.0
        # Fell way behind - jump next tick time
        @next_tick_time = Time.now.sys
      end

      @pending_packets = @sim_target.read(@count_100hz, @next_tick_time)
      @next_tick_time += 0.01
      @count_100hz += 1

      packet = first_pending_packet()
      if packet
        # Support read_packet (but not read data) in protocols
        # Generic protocol use is not supported
        @read_protocols.each do |protocol|
          packet = protocol.read_packet(packet)
          return nil if packet == :DISCONNECT # Disconnect handled by thread
          break if packet == :STOP
        end
        next if packet == :STOP
        return packet
      end
    end
  else
    raise "Interface not connected"
  end
  return packet
end

#write(packet) ⇒ Object

Parameters:

  • packet (Packet) —

    Command packet to send to the simulator



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 105

def write(packet)
  if @connected
    # Update count of commands sent through this interface
    @write_count += 1
    @bytes_written += packet.length
    @written_raw_data_time = Time.now
    @written_raw_data = packet.buffer

    # Have simulated target handle the packet
    @sim_target.write(packet)
  else
    raise "Interface not connected"
  end
end

#write_raw(data) ⇒ Object

write_raw is not implemented and will raise a RuntimeError



121
122
123
 
# File 'lib/cosmos/interfaces/simulated_target_interface.rb', line 121

def write_raw(data)
  raise "write_raw not implemented for SimulatedTargetInterface"
end