openc3 6.10.2 → 6.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5cc7320f928c8941c9d4ecc2a4bc04eade3ebde86c278dfdad90aa7ac24f9d2
-  data.tar.gz: eb9cd8b34986f982c187dbccbdf0c4067f61df733161cab067a5c689b1ba53a9
+  metadata.gz: c1459e2b7d8160f09840d33a7fc6aa6314eb34367d68f41d45902a0203b37f57
+  data.tar.gz: 6de6d85032257c4e19f9470846056d5cf4aa8acc0498e4f9691543598a12856f
 SHA512:
-  metadata.gz: 5973122351e2b191d365092984db9c23ad877c8fc71c7173b014fa3a5ae363258a2eeca7863571d9206be0f781ff361586843eac57d7fa56065fef515398c06b
-  data.tar.gz: 7b664d2a9a8615a5c651002b412cd7248ca0b33e67f6af0618b04354f3ea080b5d81f7d8031ea4e98a013ca2ca4714e3fdb6b30ae5302223d7bdafd88d8c63bb
+  metadata.gz: 556297be7a37dac84357e9a4c63c0c69a8c2fae6b0f8478317c9eb5b95506880f2b4acb2c99a56e4d7d2b0e4c4f22f4cf78a244046f027b68aad6b73a87a7845
+  data.tar.gz: e36738a22fcdcfbc136a899a051f691c29b8a0701b6c6a6f79d36c3f4689d4ea8018c01b90a5908b082a07507d14f2fce3ab252fcd5abc3a04312daf935f1cfc

data/bin/openc3cli

@@ -33,6 +33,7 @@ require 'openc3/models/queue_model'
 require 'openc3/models/scope_model'
 require 'openc3/models/tool_model'
 require 'openc3/packets/packet_config'
+require 'openc3/packets/parsers/xtce_converter'
 require 'openc3/utilities/bucket'
 require 'openc3/utilities/cli_generator'
 require 'openc3/utilities/local_mode'
@@ -107,7 +108,8 @@ def xtce_converter(args)
   options = {}
   option_parser = OptionParser.new do |opts|
     opts.banner = "Usage: xtce_converter [options] --import input_xtce_filename --output output_dir\n"+
-      "       xtce_converter [options] --plugin /PATH/FILENAME.gem --output output_dir --variables variables.txt"
+      "       xtce_converter [options] --plugin /PATH/FILENAME.gem --output output_dir "+ 
+      "              --variables variables.txt --root_target root_target_name --time_association_name time_association_name"
     opts.separator("")
     opts.on("-h", "--help", "Show this message") do
       puts opts
@@ -125,6 +127,12 @@ def xtce_converter(args)
     opts.on("-v", "--variables", "Optional variables file to pass to the plugin") do |arg|
       options[:variables] = arg
     end
+    opts.on("-r ROOT_TARGET", "--root_target ROOT_TARGET", "Optional flag to set which target is at the root of an XTCE document. If not specified, each target will be placed under a generic 'root' spacesystem") do |arg|
+      options[:root_target_name] = arg
+    end
+    opts.on("-t TIME_ASSOCIATION_NAME", "--time_association_name TIME_ASSOCIATION_NAME", "Optional flag to set which target is at the root of an XTCE document. If not specified, each target will be placed under a generic 'root' spacesystem") do |arg|
+      options[:time_association_name] = "PACKET_TIME"
+    end
   end
 
   begin
@@ -156,8 +164,10 @@ def xtce_converter(args)
       puts "Installing #{File.basename(options[:plugin])}"
       plugin_hash = OpenC3::PluginModel.install_phase1(options[:plugin], existing_variables: variables, scope: 'DEFAULT', validate_only: true)
       plugin_hash['variables']['xtce_output'] = options[:output]
+      plugin_hash['variables']['time_association_name'] = options[:time_association_name]
       OpenC3::PluginModel.install_phase2(plugin_hash, scope: 'DEFAULT', validate_only: true,
         gem_file_path: options[:plugin])
+      OpenC3::XtceConverter.combine_output_xtce(options[:output], options[:root_target_name])
       result = 0 # bash and Windows consider 0 success
     rescue => e
       puts "Error: #{e.message}"

data/data/config/item_modifiers.yaml

@@ -79,12 +79,12 @@ GENERIC_READ_CONVERSION_START:
   ruby_example: |
     APPEND_ITEM ITEM1 32 UINT
       GENERIC_READ_CONVERSION_START
-        return (value * 1.5).to_i # Convert the value by a scale factor
+        (value * 1.5).to_i # Convert the value by a scale factor
       GENERIC_READ_CONVERSION_END
   python_example: |
     APPEND_ITEM ITEM1 32 UINT
       GENERIC_READ_CONVERSION_START
-        return int(value * 1.5) # Convert the value by a scale factor
+        int(value * 1.5) # Convert the value by a scale factor
       GENERIC_READ_CONVERSION_END
   parameters:
     - name: Converted Type

data/data/config/parameter_modifiers.yaml

@@ -141,12 +141,12 @@ GENERIC_WRITE_CONVERSION_START:
   ruby_example: |
     APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0
       GENERIC_WRITE_CONVERSION_START
-        return (value * 1.5).to_i # Convert the value by a scale factor
+        (value * 1.5).to_i # Convert the value by a scale factor
       GENERIC_WRITE_CONVERSION_END
   python_example: |
     APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0
       GENERIC_WRITE_CONVERSION_START
-        return int(value * 1.5) # Convert the value by a scale factor
+        int(value * 1.5) # Convert the value by a scale factor
       GENERIC_WRITE_CONVERSION_END
 GENERIC_WRITE_CONVERSION_END:
   summary: Complete a generic write conversion

data/data/config/screen.yaml

@@ -125,6 +125,29 @@ SUBSETTING:
       LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
         SUBSETTING 0 TEXTCOLOR green # Change the label's text to green
     END
+TOOLTIP:
+  summary: Adds a tooltip to the previously defined widget
+  description: TOOLTIP applies a custom hover tooltip to the widget defined immediately before it.
+    This allows you to provide helpful descriptions, mnemonics, or other contextual information
+    that appears when the user hovers over a widget. The tooltip overrides any default tooltip
+    that the widget may have.
+  since: 6.10.3
+  parameters:
+    - name: Tooltip Text
+      required: true
+      description: The text to display in the tooltip when hovering over the widget.
+      values: .+
+    - name: Delay
+      required: false
+      description: The delay in milliseconds before the tooltip appears (default = 600).
+      values: \d+
+  example: |
+    LED INST PARAMS VALUE5 RAW 25 20
+      SETTING LED_COLOR 0 GREEN
+      SETTING LED_COLOR 1 RED
+      TOOLTIP "Mnemonic: ABCDEF. This is the Star Tracker On/Off Status"
+    VALUE INST HEALTH_STATUS TEMP1
+      TOOLTIP "Temperature sensor 1: Primary thermal control" 1000
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method
   description: To programmatically access parts of a telemetry screen you need

data/data/config/target.yaml

@@ -1,7 +1,7 @@
 ---
 TARGET:
   summary: Defines a new target
-  example: TARGET INST INST
+  example: TARGET KEYSIGHT_N6700 PWR_SUPPLY1
   parameters:
     - name: Folder Name
       required: true
@@ -10,8 +10,13 @@ TARGET:
     - name: Name
       required: true
       description:
-        The target name. While this is almost always the same as Folder Name
-        it can be different to create multiple targets based on the same target folder.
+        The target name. While this typically matches the Folder Name
+        it can be different to create multiple targets based on the same target definition.
+        As in the Example Usage, the target folder is KEYSIGHT_N6700 but the target name is PWR_SUPPLY1.
+        To create multiple targets from the same folder, just define multiple TARGET entries
+        with different target names. To make the target definition flexbible, you can use ERB to
+        insert the target name in procedures, libraries, etc via <%= target_name %>.
+        See [ERB target_name](/docs/configuration/format#target_name) for more information.
       values: .*
   modifiers:
     CMD_BUFFER_DEPTH:

data/data/config/widgets.yaml

@@ -204,6 +204,36 @@ Decoration Widgets:
           SPACER 0 100
           LABEL "Spacer above"
         END
+    FILEDISPLAY:
+      summary: Displays the contents of a target file with syntax highlighting
+      since: 6.10.3
+      parameters:
+        - name: File path
+          required: true
+          description: Path to the file relative to the target folder (e.g. "INST/procedures/file.rb")
+          values: .+
+        - name: Width
+          required: false
+          description: Width of the widget in pixels (default = 600)
+          values: \d+
+        - name: Height
+          required: false
+          description: Height of the widget in pixels (default = 300)
+          values: \d+
+      example: |
+        FILEDISPLAY "INST/data/sample.json" 400 200
+    FILECHECKSUM:
+      summary: Displays SHA-256 checksum of one or more files, with comparison if multiple
+      since: 6.10.3
+      parameters:
+        - name: File path
+          required: true
+          description: Path to a file relative to the target folder (e.g. "INST/procedures/file.rb"). Multiple file paths can be provided to compare checksums.
+          values: .+
+      example: |
+        FILECHECKSUM "INST/data/sample.json"
+        FILECHECKSUM "INST/data/sample.json" "INST2/data/sample.json"
+        FILECHECKSUM "INST/data/file1.bin" "INST/data/file2.bin" "INST/data/file3.bin"
 Telemetry Widgets:
   description: Telemetry widgets are used to display telemetry values.
     The first parameters to each of these widgets is a telemetry mnemonic.

data/lib/openc3/accessors/json_accessor.rb

@@ -25,7 +25,7 @@ require 'openc3/accessors/accessor'
 OpenC3.disable_warnings do
   class JsonPath
     def self.process_object(obj_or_str, opts = {})
-      obj_or_str.is_a?(String) ? MultiJson.decode(obj_or_str, max_nesting: opts[:max_nesting], create_additions: true, allow_nan: true) : obj_or_str
+      obj_or_str.is_a?(String) ? MultiJson.load(obj_or_str, max_nesting: opts[:max_nesting], create_additions: true, allow_nan: true) : obj_or_str
     end
   end
 end

data/lib/openc3/api/tlm_api.rb

@@ -284,13 +284,8 @@ module OpenC3
             value_type = 'RAW' # Must request the raw value when dealing with the reserved items
           end
 
-          # QuestDB 9.0.0 only supports DOUBLE arrays: https://questdb.com/docs/concept/array/
+          # Arrays must be accessed as RAW since there's no conversion
           if item['array_size']
-            # TODO: This needs work ... we're JSON encoding non numeric array values
-            if item['data_type'] == 'STRING' or item['data_type'] == 'BLOCK'
-              results << nil
-              next
-            end
             value_type = 'RAW'
           end
 

data/lib/openc3/io/json_api_object.rb

@@ -34,6 +34,10 @@ require 'faraday'
 
 
 module OpenC3
+  # Number of times to retry a request when a connection error occurs
+  RETRY_COUNT = 3
+  # Delay between retries in seconds
+  RETRY_DELAY = 0.1
 
   class JsonApiError < StandardError; end
 
@@ -200,21 +204,41 @@ module OpenC3
 
     # NOTE: This is a helper method and should not be called directly
     def _send_request(method:, endpoint:, kwargs:)
-      begin
-        uri = URI("#{@url}#{endpoint}")
-        @log[0] = "#{method} Request: #{uri.to_s} #{kwargs}"
-        STDOUT.puts @log[0] if JsonDRb.debug?
-        resp = _http_request(method: method, uri: uri, kwargs: kwargs)
-        @log[1] = "#{method} Response: #{resp.status} #{resp.headers} #{resp.body}"
-        STDOUT.puts @log[1] if JsonDRb.debug?
-        @response_data = resp.body
-        return resp
-      rescue StandardError => e
-        @log[2] = "#{method} Exception: #{e.class}, #{e.message}, #{e.backtrace}"
-        disconnect()
-        error = "Api Exception: #{@log[0]} ::: #{@log[1]} ::: #{@log[2]}"
-        raise error
+      uri = URI("#{@url}#{endpoint}")
+      @log[0] = "#{method} Request: #{uri.to_s} #{kwargs}"
+      STDOUT.puts @log[0] if JsonDRb.debug?
+
+      retry_count = 0
+      while retry_count <= RETRY_COUNT
+        begin
+          resp = _http_request(method: method, uri: uri, kwargs: kwargs)
+          @log[1] = "#{method} Response: #{resp.status} #{resp.headers} #{resp.body}"
+          STDOUT.puts @log[1] if JsonDRb.debug?
+          @response_data = resp.body
+          return resp
+        rescue Faraday::ConnectionFailed, Errno::ECONNRESET, Errno::EPIPE, IOError => e
+          # Connection errors are retryable - reconnect and try again
+          retry_count += 1
+          @log[2] = "#{method} Exception: #{e.class}, #{e.message}, #{e.backtrace}"
+          if retry_count <= RETRY_COUNT
+            Logger.warn("JsonApiObject: Connection error, retry #{retry_count}/#{RETRY_COUNT}: #{e.class} #{e.message}")
+            disconnect()
+            sleep(RETRY_DELAY)
+            connect()
+          else
+            error = "Api Exception: #{@log[0]} ::: #{@log[1]} ::: #{@log[2]}"
+            raise error
+          end
+        rescue StandardError => e
+          @log[2] = "#{method} Exception: #{e.class}, #{e.message}, #{e.backtrace}"
+          disconnect()
+          error = "Api Exception: #{@log[0]} ::: #{@log[1]} ::: #{@log[2]}"
+          raise error
+        end
       end
+      # Should not reach here, but just in case
+      error = "Api Exception: #{@log[0]} ::: #{@log[1]} ::: #{@log[2]}"
+      raise error
     end
 
     # NOTE: This is a helper method and should not be called directly

data/lib/openc3/io/json_drb_object.rb

@@ -92,18 +92,36 @@ module OpenC3
           'Content-Type' => 'application/json-rpc',
         }
       end
-      begin
-        @log[0] = "Request: #{@uri.to_s} #{USER_AGENT} #{data.to_s}"
-        STDOUT.puts @log[0] if JsonDRb.debug?
-        resp = @http.post(@uri, data, headers)
-        @log[1] = "Response: #{resp.status} #{resp.headers} #{resp.body}"
-        @response_data = resp.body
-        STDOUT.puts @log[1] if JsonDRb.debug?
-        return resp.body
-      rescue StandardError => e
-        @log[2] = "Exception: #{e.class}, #{e.message}, #{e.backtrace}"
-        return nil
+
+      @log[0] = "Request: #{@uri.to_s} #{USER_AGENT} #{data.to_s}"
+      STDOUT.puts @log[0] if JsonDRb.debug?
+
+      retry_count = 0
+      while retry_count <= RETRY_COUNT
+        begin
+          resp = @http.post(@uri, data, headers)
+          @log[1] = "Response: #{resp.status} #{resp.headers} #{resp.body}"
+          @response_data = resp.body
+          STDOUT.puts @log[1] if JsonDRb.debug?
+          return resp.body
+        rescue Faraday::ConnectionFailed, Errno::ECONNRESET, Errno::EPIPE, IOError => e
+          # Connection errors are retryable - reconnect and try again
+          retry_count += 1
+          @log[2] = "Exception: #{e.class}, #{e.message}, #{e.backtrace}"
+          if retry_count <= RETRY_COUNT
+            Logger.warn("JsonDRbObject: Connection error, retry #{retry_count}/#{RETRY_COUNT}: #{e.class} #{e.message}")
+            disconnect()
+            sleep(RETRY_DELAY)
+            connect()
+          else
+            return nil
+          end
+        rescue StandardError => e
+          @log[2] = "Exception: #{e.class}, #{e.message}, #{e.backtrace}"
+          return nil
+        end
       end
+      return nil
     end
 
     def handle_response(response:)

data/lib/openc3/microservices/interface_microservice.rb

@@ -89,6 +89,7 @@ module OpenC3
       InterfaceTopic.receive_commands(@interface, scope: @scope) do |topic, msg_id, msg_hash, _redis|
         OpenC3.with_context(msg_hash) do
           release_critical = false
+          critical_model = nil
           msgid_seconds_from_epoch = msg_id.split('-')[0].to_i / 1000.0
           delta = Time.now.to_f - msgid_seconds_from_epoch
           @metric.set(name: 'interface_topic_delta_seconds', value: delta, type: 'gauge', unit: 'seconds', help: 'Delta time between data written to stream and interface cmd start') if @metric
@@ -188,9 +189,9 @@ module OpenC3
             end
             if msg_hash.key?('release_critical')
               # Note: intentional fall through below this point
-              model = CriticalCmdModel.get_model(name: msg_hash['release_critical'], scope: @scope)
-              if model
-                msg_hash = model.cmd_hash
+              critical_model = CriticalCmdModel.get_model(name: msg_hash['release_critical'], scope: @scope)
+              if critical_model
+                msg_hash = critical_model.cmd_hash
                 release_critical = true
               else
                 next "Critical command #{msg_hash['release_critical']} not found"
@@ -279,6 +280,10 @@ module OpenC3
             command.extra ||= {}
             command.extra['cmd_string'] = msg_hash['cmd_string']
             command.extra['username'] = msg_hash['username']
+            # Add approver info if this was a critical command that was approved
+            if critical_model
+              command.extra['approver'] = critical_model.approver
+            end
             hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
 
             # Initial Are you sure? Hazardous check

data/lib/openc3/models/target_model.rb

@@ -638,7 +638,8 @@ module OpenC3
         system = System.new([@name], temp_dir)
         if variables["xtce_output"]
           puts "Converting target #{@name} to .xtce files in #{variables["xtce_output"]}/#{@name}"
-          system.packet_config.to_xtce(variables["xtce_output"])
+          puts "    Using mnemonic '#{variables['time_association_name']}' as the packet time item."
+          system.packet_config.to_xtce(variables["xtce_output"], variables['time_association_name'])
         end
         unless validate_only
           build_target_archive(temp_dir, target_folder)

data/lib/openc3/packets/packet.rb

@@ -433,6 +433,9 @@ module OpenC3
       previous_item = nil
       warnings = []
       @sorted_items.each do |item|
+        # Skip items with a parent_item since those are accessor-based items within a structure
+        # (e.g., JSON, CBOR) that don't have meaningful bit positions - they share the parent's bit_offset
+        next if item.parent_item
         if expected_next_offset and (item.bit_offset < expected_next_offset) and !item.overlap
           msg = "Bit definition overlap at bit offset #{item.bit_offset} for packet #{@target_name} #{@packet_name} items #{item.name} and #{previous_item.name}"
           Logger.instance.warn(msg)

data/lib/openc3/packets/packet_config.rb

@@ -331,8 +331,8 @@ module OpenC3
       end
     end # def to_config
 
-    def to_xtce(output_dir)
-      XtceConverter.convert(@commands, @telemetry, output_dir)
+    def to_xtce(output_dir, time_association_name)
+      XtceConverter.convert(@commands, @telemetry, output_dir, time_association_name)
     end
 
     # Add current packet into hash if it exists

data/lib/openc3/packets/parsers/packet_item_parser.rb

@@ -65,6 +65,15 @@ module OpenC3
         @parser.verify_num_parameters(max_options - 2, max_options, @usage)
       end
       @parser.verify_parameter_naming(1) # Item name is the 1st parameter
+
+      # ARRAY items cannot have brackets in their name because brackets are used
+      # for array indexing in the UI and would cause confusion
+      if @parser.keyword.include?('ARRAY')
+        item_name = @parser.parameters[0]
+        if item_name.include?('[') || item_name.include?(']')
+          raise @parser.error("ARRAY items cannot have brackets in their name: #{item_name}", @usage)
+        end
+      end
     end
 
     def create_packet_item(packet, cmd_or_tlm)