Class: OpenC3::InterfaceTopic

Inherits:
Topic show all
Defined in:
lib/openc3/topics/interface_topic.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Topic

clear_topics, get_cnt, method_missing

Class Method Details

.connect_interface(interface_name, *interface_params, scope:) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/openc3/topics/interface_topic.rb', line 54

def self.connect_interface(interface_name, *interface_params, scope:)
  if interface_params && !interface_params.empty?
    Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'connect' => 'true', 'params' => JSON.generate(interface_params) }, '*', 100)
  else
    Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'connect' => 'true' }, '*', 100)
  end
end

.disconnect_interface(interface_name, scope:) ⇒ Object 



62
63
64
 
# File 'lib/openc3/topics/interface_topic.rb', line 62

def self.disconnect_interface(interface_name, scope:)
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'disconnect' => 'true' }, '*', 100)
end

.receive_commands(interface, scope:) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/openc3/topics/interface_topic.rb', line 38

def self.receive_commands(interface, scope:)
  while true
    Topic.read_topics(InterfaceTopic.topics(interface, scope: scope)) do |topic, msg_id, msg_hash, redis|
      result = yield topic, msg_hash
      ack_topic = topic.split("__")
      ack_topic[1] = 'ACK' + ack_topic[1]
      ack_topic = ack_topic.join("__")
      Topic.write_topic(ack_topic, { 'result' => result, 'id' => msg_id }, '*', 100)
    end
  end
end

.shutdown(interface, scope:) ⇒ Object 



74
75
76
77
78
 
# File 'lib/openc3/topics/interface_topic.rb', line 74

def self.shutdown(interface, scope:)
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface.name}", { 'shutdown' => 'true' }, '*', 100)
  sleep 1 # Give some time for the interface to shutdown
  InterfaceTopic.clear_topics(InterfaceTopic.topics(interface, scope: scope))
end

.start_raw_logging(interface_name, scope:) ⇒ Object 



66
67
68
 
# File 'lib/openc3/topics/interface_topic.rb', line 66

def self.start_raw_logging(interface_name, scope:)
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'log_raw' => 'true' }, '*', 100)
end

.stop_raw_logging(interface_name, scope:) ⇒ Object 



70
71
72
 
# File 'lib/openc3/topics/interface_topic.rb', line 70

def self.stop_raw_logging(interface_name, scope:)
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'log_raw' => 'false' }, '*', 100)
end

.topics(interface, scope:) ⇒ Object

Generate a list of topics for this interface. This includes the interface itself and all the targets which are assigned to this interface.



29
30
31
32
33
34
35
36
 
# File 'lib/openc3/topics/interface_topic.rb', line 29

def self.topics(interface, scope:)
  topics = []
  topics << "{#{scope}__CMD}INTERFACE__#{interface.name}"
  interface.cmd_target_names.each do |target_name|
    topics << "{#{scope}__CMD}TARGET__#{target_name}"
  end
  topics
end

.write_raw(interface_name, data, scope:) ⇒ Object 



50
51
52
 
# File 'lib/openc3/topics/interface_topic.rb', line 50

def self.write_raw(interface_name, data, scope:)
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'raw' => data }, '*', 100)
end

Instance Method Details

#interface_cmd(interface_name, cmd_name, *cmd_params, scope:) ⇒ Object 



80
81
82
83
84
85
 
# File 'lib/openc3/topics/interface_topic.rb', line 80

def interface_cmd(interface_name, cmd_name, *cmd_params, scope:)
  data = {}
  data['cmd_name'] = cmd_name
  data['cmd_params'] = cmd_params
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'interface_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
end

#protocol_cmd(interface_name, cmd_name, *cmd_params, read_write: :READ_WRITE, index: -1,, scope:) ⇒ Object 



87
88
89
90
91
92
93
94
 
# File 'lib/openc3/topics/interface_topic.rb', line 87

def protocol_cmd(interface_name, cmd_name, *cmd_params, read_write: :READ_WRITE, index: -1, scope:)
  data = {}
  data['cmd_name'] = cmd_name
  data['cmd_params'] = cmd_params
  data['read_write'] = read_write.to_s.upcase
  data['index'] = index
  Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'protocol_cmd' => JSON.generate(data, allow_nan: true) }, '*', 100)
end