openc3 5.5.2 → 5.6.0

data/lib/openc3/api/cmd_api.rb

@@ -22,6 +22,7 @@
 
 require 'openc3/models/target_model'
 require 'openc3/topics/command_topic'
+require 'openc3/topics/command_decom_topic'
 require 'openc3/topics/interface_topic'
 require 'openc3/script/extract'
 
@@ -313,9 +314,19 @@ module OpenC3
     # PRIVATE implementation details
     ###########################################################################
 
-    def cmd_implementation(method_name, *args, range_check:, hazardous_check:, raw:, timeout: nil,
+    def cmd_implementation(method_name, *args, range_check:, hazardous_check:, raw:, timeout: nil, log_message: nil,
                            scope: $openc3_scope, token: $openc3_token, **kwargs)
       extract_string_kwargs_to_args(args, kwargs)
+      unless [nil, true, false].include?(log_message)
+        raise "Invalid log_message parameter: #{log_message}. Must be true or false."
+      end
+      unless timeout.nil?
+        begin
+          Float(timeout)
+        rescue ArgumentError, TypeError
+          raise "Invalid timeout parameter: #{timeout}. Must be numeric."
+        end
+      end
 
       case args.length
       when 1
@@ -346,18 +357,19 @@ module OpenC3
         'hazardous_check' => hazardous_check.to_s,
         'raw' => raw.to_s
       }
-      log_cmd = true
-      if packet["messages_disabled"]
-        log_cmd = false
-      else
+      if log_message.nil? # This means the default was used, no argument was passed
+        log_message = true # Default is true
+        # If the packet has the DISABLE_MESSAGES keyword then no messages by default
+        log_message = false if packet["messages_disabled"]
+        # Check if any of the parameters have DISABLE_MESSAGES
         cmd_params.each do |key, value|
           item = packet['items'].find { |item| item['name'] == key.to_s }
           if item['states'] && item['states'][value] && item['states'][value]["messages_disabled"]
-            log_cmd = false
+            log_message = false
           end
         end
       end
-      if log_cmd
+      if log_message
         Logger.info(build_cmd_output_string(target_name, cmd_name, cmd_params, packet, raw), scope: scope)
       end
       CommandTopic.send_command(command, timeout: timeout, scope: scope)

data/lib/openc3/api/tlm_api.rb

@@ -24,6 +24,8 @@ require 'openc3/models/target_model'
 require 'openc3/models/cvt_model'
 require 'openc3/packets/packet'
 require 'openc3/topics/telemetry_topic'
+require 'openc3/topics/interface_topic'
+require 'openc3/topics/telemetry_decom_topic'
 
 module OpenC3
   module Api
@@ -135,22 +137,21 @@ module OpenC3
         TargetModel.packet(target_name, packet_name, scope: scope)
       end
 
-      packet_hash = get_telemetry(target_name, packet_name, scope: scope, token: token)
-      packet = Packet.from_json(packet_hash)
-      if item_hash
-        item_hash.each do |name, value|
-          packet.write(name.to_s, value, type)
+      # See if this target has a tlm interface
+      interface_name = nil
+      InterfaceModel.all(scope: scope).each do |name, interface|
+        if interface['tlm_target_names'].include? target_name
+          interface_name = interface['name']
+          break
         end
       end
-      topic = "#{scope}__TELEMETRY__{#{target_name}}__#{packet_name}"
-      msg_id, msg_hash = Topic.get_newest_message(topic)
-      if msg_id
-        packet.received_count = msg_hash['received_count'].to_i + 1
+
+      # Use an interface microservice if it exists, other use the decom microservice
+      if interface_name
+        InterfaceTopic.inject_tlm(interface_name, target_name, packet_name, item_hash, type: type, scope: scope)
       else
-        packet.received_count = 1
+        TelemetryDecomTopic.inject_tlm(target_name, packet_name, item_hash, type: type, scope: scope)
       end
-      packet.received_time = Time.now.sys
-      TelemetryTopic.write_packet(packet, scope: scope)
     end
 
     # Override the current value table such that a particular item always

data/lib/openc3/bridge/bridge_config.rb

@@ -144,7 +144,7 @@ module OpenC3
           current_interface_or_router.config_params = params[1..-1]
           @interfaces[interface_name] = current_interface_or_router
 
-        when 'RECONNECT_DELAY', 'LOG_RAW', 'OPTION', 'PROTOCOL'
+        when 'RECONNECT_DELAY', 'LOG_STREAM', 'LOG_RAW', 'OPTION', 'PROTOCOL'
           raise parser.error("No current interface or router for #{keyword}") unless current_interface_or_router
 
           case keyword
@@ -153,9 +153,9 @@ module OpenC3
             parser.verify_num_parameters(1, 1, "#{keyword} <Delay in Seconds>")
             current_interface_or_router.reconnect_delay = Float(params[0])
 
-          when 'LOG_RAW',
-            parser.verify_num_parameters(0, nil, "#{keyword} <Raw Logger Class File (optional)> <Raw Logger Parameters (optional)>")
-            current_interface_or_router.raw_logger_pair = RawLoggerPair.new(current_interface_or_router.name, Dir.pwd, params)
+          when 'LOG_STREAM', 'LOG_RAW'
+            parser.verify_num_parameters(0, nil, "#{keyword} <Log Stream Class File (optional)> <Log Stream Parameters (optional)>")
+            current_interface_or_router.stream_log_pair = StreamLogPair.new(current_interface_or_router.name, params)
             current_interface_or_router.start_raw_logging
 
           when 'OPTION'

data/lib/openc3/config/config_parser.rb

@@ -23,6 +23,7 @@
 require 'openc3/top_level'
 require 'openc3/ext/config_parser' if RUBY_ENGINE == 'ruby' and !ENV['OPENC3_NO_EXT']
 require 'erb'
+require 'fileutils'
 
 module OpenC3
   # Reads OpenC3 style configuration data which consists of keywords followed

data/lib/openc3/conversions/unix_time_conversion.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/conversions/conversion'
@@ -35,6 +35,8 @@ module OpenC3
       super()
       @seconds_item_name = seconds_item_name
       @microseconds_item_name = microseconds_item_name
+      @converted_type = :RUBY_TIME
+      @converted_bit_size = 0
     end
 
     # @param (see Conversion#call)

data/lib/openc3/interfaces/interface.rb

@@ -14,14 +14,14 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/api/api'
-require 'openc3/io/raw_logger_pair'
+require 'openc3/logs/stream_log_pair'
 require 'openc3/utilities/secrets'
 
 module OpenC3
@@ -71,8 +71,8 @@ module OpenC3
     # @return [Array] Array of stored packet log writers
     attr_accessor :stored_packet_log_writer_pairs
 
-    # @return [RawLoggerPair] RawLoggerPair instance or nil
-    attr_accessor :raw_logger_pair
+    # @return [StreamLogPair] StreamLogPair instance or nil
+    attr_accessor :stream_log_pair
 
     # @return [Array<Routers>] Array of routers that receive packets
     #   read from the interface
@@ -153,8 +153,6 @@ module OpenC3
       @disable_disconnect = false
       @packet_log_writer_pairs = []
       @stored_packet_log_writer_pairs = []
-      # TODO: How should this get the log directory
-      @raw_logger_pair = RawLoggerPair.new(@name, 'outputs/logs')
       @routers = []
       @cmd_routers = []
       @read_count = 0
@@ -375,18 +373,19 @@ module OpenC3
 
     # Start raw logging for this interface
     def start_raw_logging
-      @raw_logger_pair.start if @raw_logger_pair
+      @stream_log_pair = StreamLogPair.new(@name) unless @stream_log_pair
+      @stream_log_pair.start
     end
 
     # Stop raw logging for this interface
     def stop_raw_logging
-      @raw_logger_pair.stop if @raw_logger_pair
+      @stream_log_pair.stop if @stream_log_pair
     end
 
     # Set the interface name
     def name=(name)
       @name = name.to_s.clone
-      @raw_logger_pair.name = name if @raw_logger_pair
+      @stream_log_pair.name = name if @stream_log_pair
     end
 
     # Copy settings from this interface to another interface. All instance
@@ -411,7 +410,7 @@ module OpenC3
       other_interface.write_count = self.write_count
       other_interface.bytes_read = self.bytes_read
       other_interface.bytes_written = self.bytes_written
-      other_interface.raw_logger_pair = self.raw_logger_pair.clone if @raw_logger_pair
+      other_interface.stream_log_pair = self.stream_log_pair.clone if @stream_log_pair
       # num_clients is per interface so don't copy
       # read_queue_size is the number of packets in the queue so don't copy
       # write_queue_size is the number of packets in the queue so don't copy
@@ -420,7 +419,9 @@ module OpenC3
       end
       other_interface.protocol_info = []
       self.protocol_info.each do |protocol_class, protocol_args, read_write|
-        other_interface.add_protocol(protocol_class, protocol_args, read_write)
+        unless read_write == :PARAMS
+          other_interface.add_protocol(protocol_class, protocol_args, read_write)
+        end
       end
     end
 
@@ -459,7 +460,7 @@ module OpenC3
       @read_raw_data_time = Time.now
       @read_raw_data = data.clone
       @bytes_read += data.length
-      @raw_logger_pair.read_logger.write(data) if @raw_logger_pair
+      @stream_log_pair.read_log.write(data) if @stream_log_pair
     end
 
     # Called to write data to the underlying interface. Subclasses must
@@ -472,7 +473,7 @@ module OpenC3
       @written_raw_data_time = Time.now
       @written_raw_data = data.clone
       @bytes_written += data.length
-      @raw_logger_pair.write_logger.write(data) if @raw_logger_pair
+      @stream_log_pair.write_log.write(data) if @stream_log_pair
     end
 
     def add_protocol(protocol_class, protocol_args, read_write)
@@ -483,7 +484,7 @@ module OpenC3
         @read_protocols << protocol
       when :WRITE
         @write_protocols.unshift(protocol)
-      when :READ_WRITE
+      when :READ_WRITE, :PARAMS
         @read_protocols << protocol
         @write_protocols.unshift(protocol)
       else
@@ -500,19 +501,46 @@ module OpenC3
 
     def protocol_cmd(cmd_name, *cmd_args, read_write: :READ_WRITE, index: -1)
       read_write = read_write.to_s.upcase.intern
-      protocols = nil
-      case read_write
-      when :READ, :READ_WRITE
-        protocols = @read_protocols
-      when :WRITE
-        protocols = @write_protocols.reverse # Reverse so ordering matches configuration ordering
-      else
-        raise "Unknown protocol descriptor: #{read_write}. Must be :READ, :WRITE, or :READ_WRITE."
-      end
+      raise "Unknown protocol descriptor: #{read_write}. Must be :READ, :WRITE, or :READ_WRITE." unless [:READ, :WRITE, :READ_WRITE].include?(read_write)
       handled = false
-      protocols.each_with_index do |protocol, protocol_index|
-        result = protocol.protocol_cmd(cmd_name, @cmd_args) if index == protocol_index or index == -1
-        handled = true if result
+
+      if index >= 0 or read_write == :READ_WRITE
+        # Reconstruct full list of protocols in correct order
+        protocols = []
+        read_protocols = @read_protocols
+        write_protocols = @write_protocols.reverse
+        read_index = 0
+        write_index = 0
+        @protocol_info.each do |protocol_class, protocol_args, protocol_read_write|
+          case protocol_read_write
+          when :READ
+            protocols << read_protocols[read_index]
+            read_index += 1
+          when :WRITE
+            protocols << write_protocols[write_index]
+            write_index += 1
+          when :READ_WRITE, :PARAMS
+            protocols << read_protocols[read_index]
+            read_index += 1
+            write_index += 1
+          end
+        end
+
+        protocols.each_with_index do |protocol, protocol_index|
+          # If index is given that is all that matters
+          result = protocol.protocol_cmd(cmd_name, *cmd_args) if index == protocol_index or index == -1
+          handled = true if result
+        end
+      elsif read_write == :READ # and index == -1
+        @read_protocols.each do |protocol|
+          result = protocol.protocol_cmd(cmd_name, *cmd_args)
+          handled = true if result
+        end
+      else # read_write == :WRITE and index == -1
+        @write_protocols.each do |protocol|
+          result = protocol.protocol_cmd(cmd_name, *cmd_args)
+          handled = true if result
+        end
       end
       return handled
     end

data/lib/openc3/interfaces/serial_interface.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/interfaces/stream_interface'
@@ -34,10 +34,9 @@ module OpenC3
     # @param parity [Symbol] The parity which is normally :NONE.
     #   Must be one of :NONE, :EVEN, or :ODD.
     # @param stop_bits [Integer] The number of stop bits which is normally 1.
-    # @param write_timeout [Integer] The number of seconds to attempt the write
-    #   before aborting
-    # @param read_timeout [Integer] The number of seconds to attempt to read
-    #   data from the serial port before aborting
+    # @param write_timeout [Float] Seconds to wait before aborting writes
+    # @param read_timeout [Float|nil] Seconds to wait before aborting reads.
+    #   Pass nil to block until the read is complete.
     # @param protocol_type [String] Combined with 'Protocol' to resolve
     #   to a OpenC3 protocol class
     # @param protocol_args [Array] Arguments to pass to the protocol constructor

data/lib/openc3/interfaces/simulated_target_interface.rb

@@ -36,7 +36,6 @@ module OpenC3
       @sim_target_class = OpenC3.require_class sim_target_file
       @sim_target = nil
       @write_raw_allowed = false
-      @raw_logger_pair = nil
     end
 
     # Initialize the simulated target object and "connect" to the target
@@ -67,8 +66,9 @@ module OpenC3
     def read
       packet = nil
       if @connected
-        packet = first_pending_packet()
-        if packet
+        while true
+          packet = first_pending_packet()
+          break unless packet
           # Support read_packet (but not read data) in protocols
           # Generic protocol use is not supported
           @read_protocols.each do |protocol|
@@ -143,7 +143,7 @@ module OpenC3
     end
 
     # Raise an error because raw logging is not supported for this interface
-    def raw_logger_pair=(raw_logger_pair)
+    def stream_log_pair=(stream_log_pair)
       raise "Raw logging not supported for SimulatedTargetInterface"
     end
 

data/lib/openc3/interfaces/stream_interface.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/interfaces/interface'
@@ -35,7 +35,7 @@ module OpenC3
       if @protocol_type
         protocol_class_name = protocol_type.to_s.capitalize << 'Protocol'
         klass = OpenC3.require_class(protocol_class_name.class_name_to_filename)
-        add_protocol(klass, protocol_args, :READ_WRITE)
+        add_protocol(klass, protocol_args, :PARAMS)
       end
     end
 

data/lib/openc3/interfaces/tcpip_client_interface.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/interfaces/stream_interface'
@@ -29,8 +29,9 @@ module OpenC3
     # @param hostname [String] Machine to connect to
     # @param write_port [Integer] Port to write commands to
     # @param read_port [Integer] Port to read telemetry from
-    # @param write_timeout [Integer] Seconds to wait before aborting writes
-    # @param read_timeout [Integer] Seconds to wait before aborting reads
+    # @param write_timeout [Float] Seconds to wait before aborting writes
+    # @param read_timeout [Float|nil] Seconds to wait before aborting reads.
+    #   Pass nil to block until the read is complete.
     # @param protocol_type [String] Name of the protocol to use
     #   with this interface
     # @param protocol_args [Array<String>] Arguments to pass to the protocol

data/lib/openc3/interfaces/tcpip_server_interface.rb

@@ -54,8 +54,8 @@ module OpenC3
     # Callback method to call when a new client connects to the read port.
     # This method will be called with the Interface as the only argument.
     attr_accessor :read_connection_callback
-    # @return [RawLoggerPair] RawLoggerPair instance or nil
-    attr_accessor :raw_logger_pair
+    # @return [StreamLogPair] StreamLogPair instance or nil
+    attr_accessor :stream_log_pair
     # @return [String] The ip address to bind to.  Default to ANY (0.0.0.0)
     attr_accessor :listen_address
 
@@ -63,10 +63,9 @@ module OpenC3
     #   and expect to receive data from this port.
     # @param read_port [Integer] The server read port. Clients should connect
     #   and expect to send data to this port.
-    # @param write_timeout [Float|nil] The number of seconds to wait for the
-    #   write to complete. Pass nil to block until the write is complete.
-    # @param read_timeout [Float|nil] The number of seconds to wait for the
-    #   read to complete. Pass nil to block until the read is complete.
+    # @param write_timeout [Float] Seconds to wait before aborting writes
+    # @param read_timeout [Float|nil] Seconds to wait before aborting reads.
+    #   Pass nil to block until the read is complete.
     # @param protocol_type [String] The name of the stream to
     #   use for both the read and write ports. This name is combined with
     #   'Protocol' to result in a OpenC3 Protocol class.
@@ -108,7 +107,7 @@ module OpenC3
       @write_raw_condition_variable = ConditionVariable.new if @write_port
       @write_connection_callback = nil
       @read_connection_callback = nil
-      @raw_logger_pair = nil
+      @stream_log_pair = nil
       @raw_logging_enabled = false
       @connection_mutex = Mutex.new
       @listen_address = "0.0.0.0"
@@ -294,19 +293,19 @@ module OpenC3
       @connection_mutex.synchronize do
         interface_infos.each do |interface_info|
           interface_info.interface.disconnect
-          interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
+          interface_info.interface.stream_log_pair.stop if interface_info.interface.stream_log_pair
         end
         interface_infos.clear
       end
     end
 
     def change_raw_logging(method)
-      if @raw_logger_pair
+      if @stream_log_pair
         @write_interface_infos.each do |interface_info|
-          interface_info.interface.raw_logger_pair.public_send(method) if interface_info.interface.raw_logger_pair
+          interface_info.interface.stream_log_pair.public_send(method) if interface_info.interface.stream_log_pair
         end
         @read_interface_infos.each do |interface_info|
-          interface_info.interface.raw_logger_pair.public_send(method) if interface_info.interface.raw_logger_pair
+          interface_info.interface.stream_log_pair.public_send(method) if interface_info.interface.stream_log_pair
         end
       end
     end
@@ -394,9 +393,9 @@ module OpenC3
       interface.target_names = @target_names
       interface.cmd_target_names = @cmd_target_names
       interface.tlm_target_names = @tlm_target_names
-      if @raw_logger_pair
-        interface.raw_logger_pair = @raw_logger_pair.clone
-        interface.raw_logger_pair.start if @raw_logging_enabled
+      if @stream_log_pair
+        interface.stream_log_pair = @stream_log_pair.clone
+        interface.stream_log_pair.start if @raw_logging_enabled
       end
       @protocol_info.each do |protocol_class, protocol_args, read_write|
         interface.add_protocol(protocol_class, protocol_args, read_write)
@@ -440,7 +439,7 @@ module OpenC3
               if interface_info.interface == read_interface_info.interface
                 index_to_delete = index
                 read_interface_info.interface.disconnect
-                read_interface_info.interface.raw_logger_pair.stop if read_interface_info.interface.raw_logger_pair
+                read_interface_info.interface.stream_log_pair.stop if read_interface_info.interface.stream_log_pair
                 break
               end
               index += 1
@@ -503,7 +502,7 @@ module OpenC3
       Logger.info "#{@name}: Tcpip server lost write connection to "\
                            "#{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
       interface_info.interface.disconnect
-      interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
+      interface_info.interface.stream_log_pair.stop if interface_info.interface.stream_log_pair
     end
 
     def write_thread_hook(packet)
@@ -554,13 +553,13 @@ module OpenC3
           # Client has disconnected (or is invalidly sending data on the socket)
           Logger.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
           interface_info.interface.disconnect
-          interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
+          interface_info.interface.stream_log_pair.stop if interface_info.interface.stream_log_pair
           indexes_to_delete.unshift(index) # Put later indexes at front of array
         rescue Errno::ECONNRESET, Errno::ECONNABORTED, IOError
           # Client has disconnected
           Logger.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
           interface_info.interface.disconnect
-          interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
+          interface_info.interface.stream_log_pair.stop if interface_info.interface.stream_log_pair
           indexes_to_delete.unshift(index) # Put later indexes at front of array
         rescue Errno::EWOULDBLOCK
           # Client is still cleanly connected as far as we can tell without writing to the socket
@@ -607,7 +606,7 @@ module OpenC3
           if need_disconnect
             Logger.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
             interface_info.interface.disconnect
-            interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
+            interface_info.interface.stream_log_pair.stop if interface_info.interface.stream_log_pair
             indexes_to_delete.unshift(index) # Put later indexes at front of array
           end
           index += 1

data/lib/openc3/interfaces/udp_interface.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/interfaces/interface'
@@ -36,8 +36,9 @@ module OpenC3
     #   configure the outgoing multicast address.
     # @param ttl [Integer] Time To Live value. The number of intermediate
     #   routers allowed before dropping the packet.
-    # @param write_timeout [Integer] Seconds to wait before aborting writes
-    # @param read_timeout [Integer] Seconds to wait before aborting reads
+    # @param write_timeout [Float] Seconds to wait before aborting writes
+    # @param read_timeout [Float|nil] Seconds to wait before aborting reads.
+    #   Pass nil to block until the read is complete.
     # @param bind_address [String] Address to bind UDP ports to
     def initialize(
       hostname,
@@ -70,7 +71,12 @@ module OpenC3
       @ttl = ttl.to_i
       @ttl = 1 if @ttl < 1
       @write_timeout = ConfigParser.handle_nil(write_timeout)
-      @write_timeout = @write_timeout.to_f if @write_timeout
+      if @write_timeout
+        @write_timeout = @write_timeout.to_f
+      else
+        Logger.instance.warn("Warning: To avoid interface lock, write_timeout can not be nil. Setting to 10 seconds.")
+        @write_timeout = 10.0
+      end
       @read_timeout = ConfigParser.handle_nil(read_timeout)
       @read_timeout = @read_timeout.to_f if @read_timeout
       @bind_address = ConfigParser.handle_nil(bind_address)

data/lib/openc3/io/json_api.rb

@@ -0,0 +1,72 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/io/json_api_object'
+require 'openc3/utilities/authentication'
+
+module OpenC3
+  class JsonApi
+    # Create a JsonApiObject connection to the API server
+    def initialize(microservice_name:, prefix:, schema: 'http', hostname: nil, port:, timeout: 5.0, url: nil, scope: $openc3_scope)
+      url = _generate_url(microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, scope: scope) unless url
+      @json_api = JsonApiObject.new(
+        url: url,
+        timeout: timeout,
+        authentication: _generate_auth()
+      )
+    end
+
+    def shutdown
+      @json_api.shutdown
+    end
+
+    # private
+
+    # pull openc3-cosmos-script-runner-api url from environment variables
+    def _generate_url(microservice_name:, prefix:, schema: 'http', hostname: nil, port:, scope: $openc3_scope)
+      prefix = '/' + prefix unless prefix[0] == '/'
+      if ENV['KUBERNETES_SERVICE_HOST']
+        hostname = "#{scope}__USER__#{microservice_name}" unless hostname
+        hostname = hostname.downcase.gsub("__", "-").gsub("_", "-")
+        return "#{schema}://#{hostname}-service:#{port.to_i}#{prefix}"
+      else
+        hostname = 'openc3-operator' unless hostname
+        return "#{schema}://#{hostname}:#{port.to_i}#{prefix}"
+      end
+    end
+
+    # generate the auth object
+    def _generate_auth
+      if ENV['OPENC3_API_TOKEN'].nil? and ENV['OPENC3_API_USER'].nil?
+        if ENV['OPENC3_API_PASSWORD'] || ENV['OPENC3_SERVICE_PASSWORD']
+          return OpenC3Authentication.new()
+        else
+          return nil
+        end
+      else
+        return OpenC3KeycloakAuthentication.new(ENV['OPENC3_KEYCLOAK_URL'])
+      end
+    end
+
+    def _request(*method_params, **kw_params)
+      kw_params[:scope] = $openc3_scope unless kw_params[:scope]
+      kw_params[:json] => true unless kw_params[:json]
+      @json_api.request(*method_params, **kw_params)
+    end
+  end
+end

data/lib/openc3/io/serial_driver.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/core_ext/kernel'
@@ -39,10 +39,9 @@ module OpenC3
     # @param baud_rate [Integer] Serial port baud rate
     # @param parity [Symbol] Must be one of :EVEN, :ODD or :NONE
     # @param stop_bits [Integer] Number of stop bits
-    # @param write_timeout [Float|nil] Number of seconds to wait for the write to
-    #   complete or nil to block
-    # @param read_timeout [Float|nil] Number of seconds to wait for the read to
-    #   complete or nil to block
+    # @param write_timeout [Float] Seconds to wait before aborting writes
+    # @param read_timeout [Float|nil] Seconds to wait before aborting reads.
+    #   Pass nil to block until the read is complete.
     # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
     def initialize(port_name,