openc3 6.10.2 → 6.10.4

data/lib/openc3/io/json_rpc.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2025, OpenC3, Inc.
+# All changes Copyright 2026, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -58,21 +58,32 @@ end
 class String
   NON_ASCII_PRINTABLE = /[^\x21-\x7e\s]/
   NON_UTF8_PRINTABLE = /[\x00-\x08\x0E-\x1F\x7F]/
-  def as_json(_options = nil)
-    # If string is ASCII-8BIT (binary) and has non-ASCII bytes (> 127), encode as binary
-    # This handles data from hex_to_byte_string and other binary sources
-    if self.encoding == Encoding::ASCII_8BIT && self.bytes.any? { |b| b > 127 }
-      return self.to_json_raw_object
-    end
+  # Matches characters outside the Latin range (U+0000-U+00FF) or C1 control characters (U+0080-U+009F)
+  # Latin range covers Basic Latin (U+0000-U+007F) and Latin-1 Supplement (U+00A0-U+00FF)
+  # This includes common characters like µ (U+00B5), ° (U+00B0), ñ (U+00F1), etc.
+  OUTSIDE_LATIN_RANGE = /[^\u0000-\u007F\u00A0-\u00FF]/
 
+  def as_json(_options = nil)
+    # Try to interpret the string as UTF-8
+    # This handles both:
+    # 1. Unicode text in ASCII-8BIT strings (e.g., "µA" for micro-Ampères from config files)
+    # 2. Binary data from hex_to_byte_string (e.g., \xDE\xAD\xBE\xEF) which will fail valid_encoding?
     as_utf8 = self.dup.force_encoding('UTF-8')
     if as_utf8.valid_encoding?
+      # Valid UTF-8 - check for non-printable control characters
       if as_utf8 =~ NON_UTF8_PRINTABLE
         return self.to_json_raw_object
-      else
-        return as_utf8
       end
+      # Check if all characters are in the expected Latin range (U+0000-U+00FF)
+      # This prevents binary data that happens to be valid UTF-8 from being treated as text
+      # For example, \xDE\xAD decodes to U+07AD (Thaana script) which should be treated as binary
+      # Also reject C1 control characters (U+0080-U+009F) which are non-printable
+      if as_utf8 =~ OUTSIDE_LATIN_RANGE
+        return self.to_json_raw_object
+      end
+      return as_utf8
     else
+      # Invalid UTF-8 means this is truly binary data, encode as raw object
       return self.to_json_raw_object
     end
   end #:nodoc:

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/plugin_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2026, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -125,11 +125,13 @@ module OpenC3
 
         # Phase 1 Gather Variables
         variables = {}
+        current_variable_name = nil
         parser.parse_file(plugin_txt_path,
                           false,
                           true,
                           false) do |keyword, params|
-          if keyword == 'VARIABLE'
+          case keyword
+          when 'VARIABLE'
             usage = "#{keyword} <Variable Name> <Default Value>"
             parser.verify_num_parameters(2, nil, usage)
             variable_name = params[0]
@@ -137,10 +139,33 @@ module OpenC3
               raise "VARIABLE name '#{variable_name}' is reserved"
             end
             value = params[1..-1].join(" ")
-            variables[variable_name] = value
+            variables[variable_name] = { 'value' => value }
+            current_variable_name = variable_name
             if existing_variables && existing_variables.key?(variable_name)
-              variables[variable_name] = existing_variables[variable_name]
+              existing = existing_variables[variable_name]
+              # Handle both old format (string) and new format (hash)
+              if existing.is_a?(Hash)
+                variables[variable_name]['value'] = existing['value']
+              else
+                variables[variable_name]['value'] = existing
+              end
+            end
+          when 'VARIABLE_DESCRIPTION'
+            usage = "#{keyword} <Description>"
+            parser.verify_num_parameters(1, 1, usage)
+            unless current_variable_name
+              raise "VARIABLE_DESCRIPTION must follow a VARIABLE definition"
             end
+            variables[current_variable_name]['description'] = params[0]
+          when 'VARIABLE_STATE'
+            usage = "#{keyword} <Display Text> <Value>"
+            parser.verify_num_parameters(2, 2, usage)
+            unless current_variable_name
+              raise "VARIABLE_STATE must follow a VARIABLE definition"
+            end
+            variables[current_variable_name]['options'] ||= []
+            option = { 'value' => params[1], 'text' => params[0] }
+            variables[current_variable_name]['options'] << option
           end
         end
 
@@ -285,20 +310,26 @@ module OpenC3
           plugin_txt_path = tf.path
           variables = plugin_hash['variables']
           variables ||= {}
-          variables['scope'] = scope
+          # Extract simple key-value pairs for ERB substitution
+          # Variables can be either new format (hash with 'value' key) or old format (string)
+          erb_variables = {}
+          variables.each do |name, var|
+            erb_variables[name] = var.is_a?(Hash) ? var['value'] : var
+          end
+          erb_variables['scope'] = scope
           if File.exist?(plugin_txt_path)
             parser = OpenC3::ConfigParser.new("https://openc3.com")
 
             current_model = nil
-            parser.parse_file(plugin_txt_path, false, true, true, variables) do |keyword, params|
+            parser.parse_file(plugin_txt_path, false, true, true, erb_variables) do |keyword, params|
               case keyword
-              when 'VARIABLE', 'NEEDS_DEPENDENCIES'
+              when 'VARIABLE', 'VARIABLE_DESCRIPTION', 'VARIABLE_STATE', 'NEEDS_DEPENDENCIES'
                 # Ignore during phase 2
               when 'TARGET', 'INTERFACE', 'ROUTER', 'MICROSERVICE', 'TOOL', 'WIDGET', 'SCRIPT_ENGINE'
                 begin
                   if current_model
                     current_model.create unless validate_only
-                    current_model.deploy(gem_path, variables, validate_only: validate_only)
+                    current_model.deploy(gem_path, erb_variables, validate_only: validate_only)
                   end
                 # If something goes wrong in create, or more likely in deploy,
                 # we want to clear the current_model and try to instantiate the next
@@ -318,7 +349,7 @@ module OpenC3
             end
             if current_model
               current_model.create unless validate_only
-              current_model.deploy(gem_path, variables, validate_only: validate_only)
+              current_model.deploy(gem_path, erb_variables, validate_only: validate_only)
               current_model = nil
             end
           end

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

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2025, OpenC3, Inc.
+# All changes Copyright 2026, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -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)
@@ -1524,7 +1527,7 @@ module OpenC3
           value = value.to_s
         end
       end
-      value << ' ' << item.units if value_type == :WITH_UNITS and item.units
+      value = "#{value} #{item.units}" if value_type == :WITH_UNITS and item.units
       value
     end
 

data/lib/openc3/packets/packet_config.rb

@@ -180,6 +180,7 @@ module OpenC3
                                     @converted_type,
                                     @converted_bit_size) if keyword.include? "WRITE"
             @building_generic_conversion = false
+            parser.set_preserve_lines(false)
           # Add the current config.line to the conversion being built
           else
             @proc_text << parser.line << "\n"
@@ -331,8 +332,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
@@ -712,6 +713,7 @@ module OpenC3
         parser.verify_num_parameters(0, 2, usage)
         @proc_text = ''
         @building_generic_conversion = true
+        parser.set_preserve_lines(true)
         @converted_type = nil
         @converted_bit_size = nil
         if params[0]

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)