Class: OpenC3::MqttStreamInterface

Inherits:
StreamInterface show all
Defined in:
lib/openc3/interfaces/mqtt_stream_interface.rb

Constant Summary

Constants included from Api

Api::DELAY_METRICS, Api::DURATION_METRICS, Api::SUBSCRIPTION_DELIMITER, Api::SUM_METRICS

Constants included from ApiShared

ApiShared::DEFAULT_TLM_POLLING_RATE

Constants included from Extract

Extract::SCANNING_REGULAR_EXPRESSION

Instance Attribute Summary

Attributes inherited from StreamInterface

#stream

Attributes inherited from Interface

#auto_reconnect, #bytes_read, #bytes_written, #cmd_routers, #cmd_target_names, #config_params, #connect_on_startup, #disable_disconnect, #interfaces, #name, #num_clients, #options, #packet_log_writer_pairs, #protocol_info, #read_count, #read_protocols, #read_queue_size, #read_raw_data, #read_raw_data_time, #reconnect_delay, #routers, #scheduler, #secrets, #state, #stored_packet_log_writer_pairs, #stream_log_pair, #target_names, #tlm_target_names, #write_count, #write_protocols, #write_queue_size, #written_raw_data, #written_raw_data_time

Instance Method Summary collapse

Methods inherited from StreamInterface

#connected?, #disconnect, #read_interface, #write_interface

Methods inherited from Interface

#_write, #add_protocol, #as_json, #connected?, #convert_data_to_packet, #convert_packet_to_data, #copy_to, #disconnect, #interface_cmd, #protocol_cmd, #read, #read_allowed?, #read_interface, #read_interface_base, #start_raw_logging, #stop_raw_logging, #write, #write_allowed?, #write_interface, #write_interface_base, #write_raw, #write_raw_allowed?

Methods included from Api

#_build_cmd_output_string, #_cmd_implementation, #_extract_target_command_names, #_extract_target_command_parameter_names, #_extract_target_packet_item_names, #_extract_target_packet_names, #_get_and_set_cmd, #_get_item, #_limits_group, #_set_tlm_process_args, #_tlm_process_args, #_validate_tlm_type, #build_cmd, #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, #config_tool_names, #connect_interface, #connect_router, #delete_config, #disable_cmd, #disable_limits, #disable_limits_group, #disconnect_interface, #disconnect_router, #enable_cmd, #enable_limits, #enable_limits_group, #get_all_cmd_names, #get_all_cmds, #get_all_interface_info, #get_all_router_info, #get_all_settings, #get_all_target_info, #get_all_tlm, #get_all_tlm_names, #get_cmd, #get_cmd_buffer, #get_cmd_cnt, #get_cmd_cnts, #get_cmd_hazardous, #get_cmd_time, #get_cmd_value, #get_interface, #get_interface_names, #get_item, #get_limits, #get_limits_events, #get_limits_groups, #get_limits_set, #get_limits_sets, #get_metrics, #get_out_of_limits, #get_overall_limits_state, #get_overrides, #get_packet_derived_items, #get_packets, #get_param, #get_router, #get_router_names, #get_setting, #get_settings, #get_target, #get_target_interfaces, #get_target_names, #get_tlm, #get_tlm_buffer, #get_tlm_cnt, #get_tlm_cnts, #get_tlm_packet, #get_tlm_values, #inject_tlm, #interface_cmd, #interface_protocol_cmd, #limits_enabled?, #list_configs, #list_settings, #load_config, #map_target_to_interface, #normalize_tlm, #offline_access_needed, #override_tlm, #router_cmd, #router_protocol_cmd, #save_config, #send_raw, #set_limits, #set_limits_set, #set_offline_access, #set_setting, #set_tlm, #start_raw_logging_interface, #start_raw_logging_router, #stash_all, #stash_delete, #stash_get, #stash_keys, #stash_set, #stop_raw_logging_interface, #stop_raw_logging_router, #subscribe_packets, #tlm, #tlm_formatted, #tlm_raw, #tlm_variable, #tlm_with_units

Constructor Details

#initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil, protocol_type = nil, *protocol_args) ⇒ MqttStreamInterface

Returns a new instance of MqttStreamInterface.

Parameters:

  • hostname (String) —

    MQTT server to connect to

  • port (Integer) (defaults to: 1883) —

    MQTT port

  • ssl (Boolean) (defaults to: false) —

    Use SSL true/false



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openc3/interfaces/mqtt_stream_interface.rb', line 27

def initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil, protocol_type = nil, *protocol_args)
  super(protocol_type, protocol_args)
  @hostname = hostname
  @port = Integer(port)
  @ssl = ConfigParser.handle_true_false(ssl)
  @write_topic = ConfigParser.handle_nil(write_topic)
  @read_topic = ConfigParser.handle_nil(read_topic)
  @username = nil
  @password = nil
  @cert = nil
  @key = nil
  @ca_file = nil
end

Instance Method Details

#connect ⇒ Object

Creates a new SerialStream using the parameters passed in the constructor



49
50
51
52
53
54
55
56
57
 
# File 'lib/openc3/interfaces/mqtt_stream_interface.rb', line 49

def connect
  @stream = MqttStream.new(@hostname, @port, @ssl, @write_topic, @read_topic)
  @stream.username = @username if @username
  @stream.password = @password if @password
  @stream.cert = @cert if @cert
  @stream.key = @key if @key
  @stream.ca_file = @ca_file if @ca_file
  super()
end

#connection_string ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/openc3/interfaces/mqtt_stream_interface.rb', line 41

def connection_string
  result = "#{@hostname}:#{@port} (ssl: #{@ssl})"
  result += " write topic: #{@write_topic}" if @write_topic
  result += " read topic: #{@read_topic}" if @read_topic
  return result
end

#set_option(option_name, option_values) ⇒ Object

Supported Options USERNAME - Username for Mqtt Server PASSWORD - Password for Mqtt Server CERT - Public Key for Client Cert Auth KEY - Private Key for Client Cert Auth CA_FILE - Certificate Authority for Client Cert Auth (see Interface#set_option)



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openc3/interfaces/mqtt_stream_interface.rb', line 66

def set_option(option_name, option_values)
  super(option_name, option_values)
  case option_name.upcase
  when 'USERNAME'
    @username = option_values[0]
  when 'PASSWORD'
    @password = option_values[0]
  when 'CERT'
    @cert = option_values[0]
  when 'KEY'
    @key = option_values[0]
  when 'CA_FILE'
    # CA_FILE must be given as a file
    @ca_file = Tempfile.new('ca_file')
    @ca_file.write(option_values[0])
    @ca_file.close
  end
end