openc3 5.4.0 → 5.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c51fd2722cde933052c2bf5941c3a111a14ae995de868bb6371faf9f32f708e
-  data.tar.gz: 0a1684b608df0335f485e59b29e55e66a1307cb62c7ab76586989a4566096946
+  metadata.gz: '08e9c285070449047388f035c8c56522154ed54cd9e075dc3b52e87f17a7ff0e'
+  data.tar.gz: d52d4c20ffd7f7ea1593d19df3be807d7dc4cc787e30390d11f8c1b90103c186
 SHA512:
-  metadata.gz: c36db608db41b6f0c1edc8ae6b83293d71eb37984e115d86a9ca9ff1e6aa4f124c3e0d645b1ac01b329d3fd490ef6a3b281ddc2754344bbdc1c78a702258522c
-  data.tar.gz: 754bc2ce9f0fd0066e47731bc5b50279ac5ce166f20752bb5be42d2ce4ab09698212ee82abcfd1ab353aa1e85029f47e5b766b4bfdba60823682c23148754837
+  metadata.gz: 5e242af794c1263642f951c46867ce5fa543ccef505c60c0d6a4015c91503acf8d62b3b7b8dd40b91ec4c252013b4a40eec21d0bb3055bc5f6ae11e370c48fbe
+  data.tar.gz: 06b2ad289fcd4bfbfa23a896469b1d9d4b55b017e4535eb060a101147b4b757535f071dd622121f78923a2d0e1923795e109b94d3c6917933e0ce74e11c586cd

data/lib/openc3/api/tlm_api.rb

@@ -37,6 +37,7 @@ module OpenC3
                        'set_tlm',
                        'inject_tlm',
                        'override_tlm',
+                       'get_overrides',
                        'normalize_tlm',
                        'get_tlm_buffer',
                        'get_tlm_packet',
@@ -169,6 +170,12 @@ module OpenC3
       CvtModel.override(target_name, packet_name, item_name, value, type: type.intern, scope: scope)
     end
 
+    # Get the list of CVT overrides
+    def get_overrides(scope: $openc3_scope, token: $openc3_token)
+      authorize(permission: 'tlm', scope: scope, token: token)
+      CvtModel.overrides(scope: scope)
+    end
+
     # Normalize a telemetry item in a packet to its default behavior. Called
     # after override_tlm to restore standard processing.
     #
@@ -394,7 +401,7 @@ module OpenC3
       return nil
     end
 
-    def tlm_process_args(args, function_name, scope: $openc3_scope, token: $openc3_token)
+    def tlm_process_args(args, method_name, scope: $openc3_scope, token: $openc3_token)
       case args.length
       when 1
         target_name, packet_name, item_name = extract_fields_from_tlm_text(args[0])
@@ -404,7 +411,7 @@ module OpenC3
         item_name = args[2]
       else
         # Invalid number of arguments
-        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{function_name}()"
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{method_name}()"
       end
       if packet_name == 'LATEST'
         latest = -1
@@ -429,7 +436,7 @@ module OpenC3
       return [target_name, packet_name, item_name]
     end
 
-    def set_tlm_process_args(args, function_name, scope: $openc3_scope, token: $openc3_token)
+    def set_tlm_process_args(args, method_name, scope: $openc3_scope, token: $openc3_token)
       case args.length
       when 1
         target_name, packet_name, item_name, value = extract_fields_from_set_tlm_text(args[0])
@@ -440,7 +447,7 @@ module OpenC3
         value = args[3]
       else
         # Invalid number of arguments
-        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{function_name}()"
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{method_name}()"
       end
       # Determine if this item exists, it will raise appropriate errors if not
       TargetModel.packet_item(target_name, packet_name, item_name, scope: scope)

data/lib/openc3/microservices/interface_microservice.rb

@@ -362,14 +362,18 @@ module OpenC3
       @interface.tlm_target_names.each do |target_name|
         # Initialize the target's packet counters based on the Topic stream
         # Prevents packet count resetting to 0 when interface restarts
-        System.telemetry.packets(target_name).each do |packet_name, packet|
-          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
-          else
-            packet.received_count = 0
+        begin
+          System.telemetry.packets(target_name).each do |packet_name, packet|
+            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
+            else
+              packet.received_count = 0
+            end
           end
+        rescue
+          # Handle targets without telemetry
         end
       end
       if @interface.connect_on_startup
@@ -649,15 +653,17 @@ module OpenC3
         # Need to make sure that @cancel_thread is set and the interface disconnected within
         # mutex to ensure that connect() is not called when we want to stop()
         @cancel_thread = true
-        @handler_thread.stop
-        @interface_thread_sleeper.cancel
-        @interface.disconnect
-        if @interface_or_router == 'INTERFACE'
-          valid_interface = InterfaceStatusModel.get_model(name: @interface.name, scope: @scope)
-        else
-          valid_interface = RouterStatusModel.get_model(name: @interface.name, scope: @scope)
+        @handler_thread.stop if @handler_thread
+        @interface_thread_sleeper.cancel if @interface_thread_sleeper
+        if @interface
+          @interface.disconnect
+          if @interface_or_router == 'INTERFACE'
+            valid_interface = InterfaceStatusModel.get_model(name: @interface.name, scope: @scope)
+          else
+            valid_interface = RouterStatusModel.get_model(name: @interface.name, scope: @scope)
+          end
+          valid_interface.destroy if valid_interface
         end
-        valid_interface.destroy if valid_interface
       end
     end
 

data/lib/openc3/models/cvt_model.rb

@@ -21,6 +21,7 @@
 # if purchased from OpenC3, Inc.
 
 require 'openc3/utilities/store'
+require 'openc3/models/target_model'
 
 module OpenC3
   class CvtModel
@@ -144,6 +145,38 @@ module OpenC3
       results
     end
 
+    # Return all the overrides
+    def self.overrides(scope: $openc3_scope)
+      overrides = []
+      TargetModel.names(scope: scope).each do |target_name|
+        all = Store.hgetall("#{scope}__override__#{target_name}")
+        next if all.nil? or all.empty?
+        all.each do |packet_name, hash|
+          items = JSON.parse(hash, :allow_nan => true, :create_additions => true)
+          items.each do |key, value|
+            item = {}
+            item['target_name'] = target_name
+            item['packet_name'] = packet_name
+            item_name, value_type_key = key.split('__')
+            item['item_name'] = item_name
+            case value_type_key
+            when 'U'
+              item['value_type'] = 'WITH_UNITS'
+            when 'F'
+              item['value_type'] = 'FORMATTED'
+            when 'C'
+              item['value_type'] = 'CONVERTED'
+            else
+              item['value_type'] = 'RAW'
+            end
+            item['value'] = value
+            overrides << item
+          end
+        end
+      end
+      overrides
+    end
+
     # Override a current value table item such that it always returns the same value
     # for the given type
     def self.override(target_name, packet_name, item_name, value, type: :ALL, scope: $openc3_scope)

data/lib/openc3/script/api_shared.rb

@@ -538,7 +538,7 @@ module OpenC3
       end
     end
 
-    def _check_process_args(args, function_name, scope: $openc3_scope, token: $openc3_token)
+    def _check_process_args(args, method_name, scope: $openc3_scope, token: $openc3_token)
       case args.length
       when 1
         target_name, packet_name, item_name, comparison_to_eval = extract_fields_from_check_text(args[0])
@@ -549,7 +549,7 @@ module OpenC3
         comparison_to_eval = args[3]
       else
         # Invalid number of arguments
-        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{function_name}()"
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{method_name}()"
       end
       return [target_name, packet_name, item_name, comparison_to_eval]
     end
@@ -679,17 +679,17 @@ module OpenC3
     # When testing an array with a tolerance, the expected value and tolerance
     # can both be supplied as either an array or a single value.  If a single
     # value is passed in, that value will be used for all array elements.
-    def array_tolerance_process_args(array_size, expected_value, tolerance, function_name, scope: $openc3_scope, token: $openc3_token)
+    def array_tolerance_process_args(array_size, expected_value, tolerance, method_name, scope: $openc3_scope, token: $openc3_token)
       if expected_value.is_a?(Array)
         if array_size != expected_value.size
-          raise "ERROR: Invalid array size for expected_value passed to #{function_name}()"
+          raise "ERROR: Invalid array size for expected_value passed to #{method_name}()"
         end
       else
         expected_value = Array.new(array_size, expected_value)
       end
       if tolerance.is_a?(Array)
         if array_size != tolerance.size
-          raise "ERROR: Invalid array size for tolerance passed to #{function_name}()"
+          raise "ERROR: Invalid array size for tolerance passed to #{method_name}()"
         end
       else
         tolerance = Array.new(array_size, tolerance)

data/lib/openc3/script/suite.rb

@@ -30,8 +30,13 @@ module OpenC3
   # and can implement setup and teardown methods. Script groups are added via add_group(Group)
   # and individual scripts added via add_script(Group, script_method).
   class Suite
-    attr_reader :scripts
-    attr_reader :plans
+    def scripts
+      @scripts ||= {}
+    end
+
+    def plans
+      @plans ||= []
+    end
 
     ###########################################################################
     # START PUBLIC API

data/lib/openc3/script/suite_runner.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/script/suite'
@@ -122,7 +122,6 @@ module OpenC3
     # Build list of Suites and Groups
     def self.build_suites
       @@suites = []
-      # @@suites = @@suites.select { |my_suite| my_suite.name == 'CustomSuite' }
       suites = {}
       groups = []
       ObjectSpace.each_object(Class) do |object|
@@ -144,7 +143,6 @@ module OpenC3
           if object.methods(false).include?(:name)
             raise FatalError.new("#{object} redefined the 'self.name' method. Delete the 'self.name' method and try again.")
           end
-
           groups << object
         end
       end
@@ -153,15 +151,18 @@ module OpenC3
         return "No Suite or no Group classes found"
       end
 
-      # Create Suite for unassigned Groups
+      # Remove assigned Groups from the array of groups
       @@suites.each do |suite|
+        next if suite.class == UnassignedSuite
         groups_to_delete = []
         groups.each { |group| groups_to_delete << group if suite.scripts[group] }
         groups_to_delete.each { |group| groups.delete(group) }
       end
       if groups.empty?
+        # If there are no unassigned group we simply remove the UnassignedSuite
         @@suites = @@suites.select { |suite| suite.class != UnassignedSuite }
       else
+        # unassigned groups should be added to the UnassignedSuite
         unassigned_suite = @@suites.select { |suite| suite.class == UnassignedSuite }[0]
         groups.each { |group| unassigned_suite.add_group(group) }
       end

data/lib/openc3/script/telemetry.rb

@@ -16,6 +16,8 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'openc3/script/extract'
+
 module OpenC3
   module Script
     private
@@ -39,5 +41,40 @@ module OpenC3
       end
       return id, packets
     end
+
+    # inject_tlm, set_tlm, override_tlm, and normalize_tlm are implemented here simply to add a puts
+    # these methods modify the telemetry so the user should be notified in the Script Runner log messages
+
+    def inject_tlm(target_name, packet_name, item_hash = nil, type: :CONVERTED, scope: $openc3_scope, token: $openc3_token)
+      puts "inject_tlm(\"#{target_name}\", \"#{packet_name}\", #{item_hash}, type: #{type})"
+      $api_server.method_missing(:inject_tlm, target_name, packet_name, item_hash, type: type, scope: scope, token: token)
+    end
+
+    def set_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "set_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "set_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:set_tlm, *args, type: type, scope: scope, token: token)
+    end
+
+    def override_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "override_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "override_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:override_tlm, *args, type: type, scope: scope, token: token)
+    end
+
+    def normalize_tlm(*args, type: :ALL, scope: $openc3_scope, token: $openc3_token)
+      if args.length == 1
+        puts "normalize_tlm(\"#{args.join('')}\", type: #{type})"
+      else
+        puts "normalize_tlm(\"#{args.join('", "')}\", type: #{type})"
+      end
+      $api_server.method_missing(:normalize_tlm, *args, type: type, scope: scope, token: token)
+    end
   end
 end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.4.0'
+OPENC3_VERSION = '5.4.2'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '4'
-    PATCH = '0'
+    PATCH = '2'
     OTHER = ''
-    BUILD = 'f10d7e7ecbe3c6917e4f87eeac1f5eb0ddcf3d67'
+    BUILD = '6a7f2b4ff8e1255aa4d9768b539211b175cb9ec7'
   end
-  VERSION = '5.4.0'
-  GEM_VERSION = '5.4.0'
+  VERSION = '5.4.2'
+  GEM_VERSION = '5.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.4.2
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler