openc3 5.0.11 → 5.1.0

data/lib/openc3/tools/table_manager/table_item_parser.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/packets/packet_config'
 require 'openc3/packets/parsers/packet_item_parser'

data/lib/openc3/tools/table_manager/table_manager_core.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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'
 require 'openc3/tools/table_manager/table_config'

data/lib/openc3/tools/table_manager/table_parser.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/packets/parsers/packet_parser'
 require 'openc3/tools/table_manager/table'

data/lib/openc3/tools/test_runner/test.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/script/suite'
 require 'openc3/script/exceptions'

data/lib/openc3/top_level.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license 
+# if purchased from OpenC3, Inc.
 
 # This file contains top level functions in the OpenC3 namespace
 

data/lib/openc3/topics/autonomic_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 

data/lib/openc3/topics/calendar_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 

data/lib/openc3/topics/command_decom_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 
@@ -30,7 +33,7 @@ module OpenC3
       msg_hash = { time: packet.received_time.to_nsec_from_epoch,
                    target_name: packet.target_name,
                    packet_name: packet.packet_name,
-                   stored: packet.stored,
+                   stored: packet.stored.to_s,
                    received_count: packet.received_count }
       json_hash = {}
       packet.sorted_items.each do |item|

data/lib/openc3/topics/command_topic.rb

@@ -16,8 +16,12 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
+require 'openc3/utilities/open_telemetry'
 
 module OpenC3
   class CommandTopic < Topic
@@ -29,7 +33,7 @@ module OpenC3
                    target_name: packet.target_name,
                    packet_name: packet.packet_name,
                    received_count: packet.received_count,
-                   stored: packet.stored,
+                   stored: packet.stored.to_s,
                    buffer: packet.buffer(false) }
       Topic.write_topic(topic, msg_hash)
     end
@@ -41,6 +45,7 @@ module OpenC3
       # Save the existing cmd_params Hash and JSON generate before writing to the topic
       cmd_params = command['cmd_params']
       command['cmd_params'] = JSON.generate(command['cmd_params'].as_json(:allow_nan => true))
+      OpenC3.inject_context(command)
       cmd_id = Topic.write_topic("{#{scope}__CMD}TARGET__#{command['target_name']}", command, '*', 100)
       # TODO: This timeout is fine for most but can we get the write_timeout from the interface here?
       time = Time.now

data/lib/openc3/topics/config_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 

data/lib/openc3/topics/interface_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 
@@ -48,8 +51,12 @@ module OpenC3
       Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'raw' => data }, '*', 100)
     end
 
-    def self.connect_interface(interface_name, scope:)
-      Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'connect' => 'true' }, '*', 100)
+    def self.connect_interface(interface_name, *interface_params, scope:)
+      if interface_params && !interface_params.empty?
+        Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'connect' => 'true', 'params' => JSON.generate(interface_params) }, '*', 100)
+      else
+        Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'connect' => 'true' }, '*', 100)
+      end
     end
 
     def self.disconnect_interface(interface_name, scope:)

data/lib/openc3/topics/limits_event_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 
@@ -23,6 +26,7 @@ module OpenC3
   # LimitsEventTopic keeps track of not only the <SCOPE>__openc3_limits_events topic
   # but also the ancillary key value stores. The LIMITS_CHANGE event updates the
   # <SCOPE>__current_limits key. The LIMITS_SET event updates the <SCOPE>__limits_sets.
+  # The LIMITS_SETTINGS event updates the <SCOPE>__current_limits_settings.
   # While this isn't a clean separation of topics (streams) and models (key-value)
   # it helps maintain consistency as the topic and model are linked.
   class LimitsEventTopic < Topic
@@ -40,6 +44,36 @@ module OpenC3
           Store.hset("#{scope}__limits_sets", event[:limits_set], 'false')
         end
 
+        field = "#{event[:target_name]}__#{event[:packet_name]}__#{event[:item_name]}"
+        limits_settings = Store.hget("#{scope}__current_limits_settings", field)
+        if limits_settings
+          limits_settings = JSON.parse(limits_settings, :allow_nan => true, :create_additions => true)
+        else
+          limits_settings = {}
+        end
+        limits = {}
+        limits['red_low'] = event[:red_low]
+        limits['yellow_low'] = event[:yellow_low]
+        limits['yellow_high'] = event[:yellow_high]
+        limits['red_high'] = event[:red_high]
+        limits['green_low'] = event[:green_low] if event[:green_low] && event[:green_high]
+        limits['green_high'] = event[:green_high] if event[:green_low] && event[:green_high]
+        limits_settings[event[:limits_set]] = limits
+        limits_settings['persistence_setting'] = event[:persistence] if event[:persistence]
+        limits_settings['enabled'] = event[:enabled] if not event[:enabled].nil?
+        Store.hset("#{scope}__current_limits_settings", field, JSON.generate(limits_settings, :allow_nan => true))
+
+      when :LIMITS_ENABLE_STATE
+        field = "#{event[:target_name]}__#{event[:packet_name]}__#{event[:item_name]}"
+        limits_settings = Store.hget("#{scope}__current_limits_settings", field)
+        if limits_settings
+          limits_settings = JSON.parse(limits_settings, :allow_nan => true, :create_additions => true)
+        else
+          limits_settings = {}
+        end
+        limits_settings['enabled'] = event[:enabled]
+        Store.hset("#{scope}__current_limits_settings", field, JSON.generate(limits_settings, :allow_nan => true))
+
       when :LIMITS_SET
         sets = sets(scope: scope)
         raise "Set '#{event[:set]}' does not exist!" unless sets.key?(event[:set])
@@ -52,25 +86,29 @@ module OpenC3
         raise "Invalid limits event type '#{event[:type]}'"
       end
 
-      Topic.write_topic("#{scope}__openc3_limits_events", event, '*', 1000)
+      Topic.write_topic("#{scope}__openc3_limits_events", {event: JSON.generate(event, :allow_nan => true)}, '*', 1000)
     end
 
+    # Remove the JSON encoding to return hashes directly
     def self.read(offset = nil, count: 100, scope:)
+      final_result = []
       topic = "#{scope}__openc3_limits_events"
       if offset
         result = Topic.read_topics([topic], [offset], nil, count)
-        if result.empty?
-          [] # We want to return an empty array rather than an empty hash
-        else
+        if not result.empty?
           # result is a hash with the topic key followed by an array of results
           # This returns just the array of arrays [[offset, hash], [offset, hash], ...]
-          result[topic]
+          final_result = result[topic]
         end
       else
         result = Topic.get_newest_message(topic)
-        return [result] if result
-        return []
+        final_result = [result] if result
       end
+      parsed_result = []
+      final_result.each do |offset, hash|
+        parsed_result << [offset, JSON.parse(hash['event'], :allow_nan => true, :create_additions => true)]
+      end
+      return parsed_result
     end
 
     def self.out_of_limits(scope:)
@@ -97,11 +135,107 @@ module OpenC3
       sets(scope: scope).key('true') || "DEFAULT"
     end
 
-    def self.delete(target_name, packet_name, scope:)
+    # Cleanups up the current_limits and current_limits_settings keys for
+    # a target or target/packet combination
+    def self.delete(target_name, packet_name = nil, scope:)
       limits = Store.hgetall("#{scope}__current_limits")
       limits.each do |item, _limits_state|
-        if item =~ /^#{target_name}__#{packet_name}__/
-          Store.hdel("#{scope}__current_limits", item)
+        if packet_name
+          if item =~ /^#{target_name}__#{packet_name}__/
+            Store.hdel("#{scope}__current_limits", item)
+          end
+        else
+          if item =~ /^#{target_name}__/
+            Store.hdel("#{scope}__current_limits", item)
+          end
+        end
+      end
+
+      limits_settings = Store.hgetall("#{scope}__current_limits_settings")
+      limits_settings.each do |item, _limits_settings|
+        if packet_name
+          if item =~ /^#{target_name}__#{packet_name}__/
+            Store.hdel("#{scope}__current_limits_settings", item)
+          end
+        else
+          if item =~ /^#{target_name}__/
+            Store.hdel("#{scope}__current_limits_settings", item)
+          end
+        end
+      end
+    end
+
+    # Update the local System based on overall state
+    def self.sync_system(scope:)
+      all_limits_settings = Store.hgetall("#{scope}__current_limits_settings")
+      telemetry = System.telemetry.all
+      all_limits_settings.each do |item, limits_settings|
+        target_name, packet_name, item_name = item.split('__')
+        target = telemetry[target_name]
+        if target
+          packet = target[packet_name]
+          if packet
+            limits_settings = JSON.parse(limits_settings, :allow_nan => true, :create_additions => true)
+            enabled = limits_settings['enabled']
+            persistence = limits_settings['persistence_setting']
+            limits_settings.each do |limits_set, settings|
+              next unless Hash === limits_set
+              System.limits.set(target_name, packet_name, item_name, settings['red_low'], settings['yellow_low'], settings['yellow_high'], settings['red_high'], settings['green_low'], settings['green_high'], limits_set.to_s.intern, persistence, enabled)
+            end
+            if not enabled.nil?
+              if enabled
+                System.limits.enable(target_name, packet_name, item_name)
+              else
+                System.limits.disable(target_name, packet_name, item_name)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # Update the local system based on limits events
+    def self.sync_system_thread_body(scope:, block_ms: nil)
+      telemetry = System.telemetry.all
+      topics = ["#{scope}__openc3_limits_events"]
+      Topic.read_topics(topics, nil, block_ms) do |topic, msg_id, event, redis|
+        event = JSON.parse(event['event'], :allow_nan => true, :create_additions => true)
+        case event['type']
+        when 'LIMITS_CHANGE'
+          # Ignore
+        when 'LIMITS_SETTINGS'
+          target_name = event['target_name']
+          packet_name = event['packet_name']
+          item_name = event['item_name']
+          target = telemetry[target_name]
+          if target
+            packet = target[packet_name]
+            if packet
+              enabled = ConfigParser.handle_true_false_nil(event['enabled'])
+              persistence = event['persistence']
+              System.limits.set(target_name, packet_name, item_name, event['red_low'], event['yellow_low'], event['yellow_high'], event['red_high'], event['green_low'], event['green_high'], event['limits_set'], persistence, enabled)
+            end
+          end
+
+        when 'LIMITS_ENABLE_STATE'
+          target_name = event['target_name']
+          packet_name = event['packet_name']
+          item_name = event['item_name']
+          target = telemetry[target_name]
+          if target
+            packet = target[packet_name]
+            if packet
+              enabled = ConfigParser.handle_true_false_nil(event['enabled'])
+              if enabled
+                System.limits.enable(target_name, packet_name, item_name)
+              else
+                System.limits.disable(target_name, packet_name, item_name)
+              end
+            end
+          end
+
+        when 'LIMITS_SET'
+          System.limits_set = event['set']
         end
       end
     end

data/lib/openc3/topics/notifications_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 

data/lib/openc3/topics/router_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 
@@ -60,12 +63,16 @@ module OpenC3
       end
     end
 
-    def self.connect_router(router_name, scope:)
-      Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'connect' => true }, '*', 100)
+    def self.connect_router(router_name, *router_params, scope:)
+      if router_params && !router_params.empty?
+        Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'connect' => 'true', 'params' => JSON.generate(router_params) }, '*', 100)
+      else
+        Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'connect' => 'true' }, '*', 100)
+      end
     end
 
     def self.disconnect_router(router_name, scope:)
-      Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'disconnect' => true }, '*', 100)
+      Topic.write_topic("{#{scope}__CMD}ROUTER__#{router_name}", { 'disconnect' => 'true' }, '*', 100)
     end
 
     def self.start_raw_logging(router_name, scope:)

data/lib/openc3/topics/telemetry_decom_topic.rb

@@ -16,8 +16,12 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
+require 'openc3/utilities/open_telemetry'
 
 module OpenC3
   class TelemetryDecomTopic < Topic
@@ -26,28 +30,30 @@ module OpenC3
     end
 
     def self.write_packet(packet, id: nil, scope:)
-      # Need to build a JSON hash of the decommutated data
-      # Support "downward typing"
-      # everything base name is RAW (including DERIVED)
-      # Request for WITH_UNITS, etc will look down until it finds something
-      # If nothing - item does not exist - nil
-      # __ as seperators ITEM1, ITEM1__C, ITEM1__F, ITEM1__U
+      OpenC3.in_span("write_packet") do
+        # Need to build a JSON hash of the decommutated data
+        # Support "downward typing"
+        # everything base name is RAW (including DERIVED)
+        # Request for WITH_UNITS, etc will look down until it finds something
+        # If nothing - item does not exist - nil
+        # __ as seperators ITEM1, ITEM1__C, ITEM1__F, ITEM1__U
 
-      json_hash = CvtModel.build_json_from_packet(packet)
-      # Write to stream
-      msg_hash = {
-        :time => packet.packet_time.to_nsec_from_epoch,
-        :stored => packet.stored,
-        :target_name => packet.target_name,
-        :packet_name => packet.packet_name,
-        :received_count => packet.received_count,
-        :json_data => JSON.generate(json_hash.as_json(:allow_nan => true)),
-      }
-      Topic.write_topic("#{scope}__DECOM__{#{packet.target_name}}__#{packet.packet_name}", msg_hash, id)
+        json_hash = CvtModel.build_json_from_packet(packet)
+        # Write to stream
+        msg_hash = {
+          :time => packet.packet_time.to_nsec_from_epoch,
+          :stored => packet.stored.to_s,
+          :target_name => packet.target_name,
+          :packet_name => packet.packet_name,
+          :received_count => packet.received_count,
+          :json_data => JSON.generate(json_hash.as_json(:allow_nan => true)),
+        }
+        Topic.write_topic("#{scope}__DECOM__{#{packet.target_name}}__#{packet.packet_name}", msg_hash, id)
 
-      unless packet.stored
-        # Also update the current value table with the latest decommutated data
-        CvtModel.set(json_hash, target_name: packet.target_name, packet_name: packet.packet_name, scope: scope)
+        unless packet.stored
+          # Also update the current value table with the latest decommutated data
+          CvtModel.set(json_hash, target_name: packet.target_name, packet_name: packet.packet_name, scope: scope)
+        end
       end
     end
   end

data/lib/openc3/topics/telemetry_reduced_topics.rb

@@ -0,0 +1,92 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, 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/topics/topic'
+require 'openc3/utilities/open_telemetry'
+
+module OpenC3
+  class TelemetryReducedMinuteTopic < Topic
+    def self.topics(scope:)
+      super(scope, 'REDUCED_MINUTE')
+    end
+
+    def self.write(target_name:, packet_name:, stored:, time:, data:, id: nil, scope:)
+      OpenC3.in_span("write") do
+        # Write to stream
+        msg_hash = {
+          :time => time,
+          :stored => stored.to_s,
+          :target_name => target_name,
+          :packet_name => packet_name,
+          :json_data => data,
+        }
+        topic = "#{scope}__REDUCED_MINUTE__{#{target_name}}__#{packet_name}"
+        offset = Topic.write_topic(topic, msg_hash, id)
+        return topic, offset
+      end
+    end
+  end
+
+  class TelemetryReducedHourTopic < Topic
+    def self.topics(scope:)
+      super(scope, 'REDUCED_HOUR')
+    end
+
+    def self.write(target_name:, packet_name:, stored:, time:, data:, id: nil, scope:)
+      OpenC3.in_span("write") do
+        # Write to stream
+        msg_hash = {
+          :time => time,
+          :stored => stored.to_s,
+          :target_name => target_name,
+          :packet_name => packet_name,
+          :json_data => data,
+        }
+        topic = "#{scope}__REDUCED_HOUR__{#{target_name}}__#{packet_name}"
+        offset = Topic.write_topic(topic, msg_hash, id)
+        return topic, offset
+      end
+    end
+  end
+
+  class TelemetryReducedDayTopic < Topic
+    def self.topics(scope:)
+      super(scope, 'REDUCED_DAY')
+    end
+
+    def self.write(target_name:, packet_name:, stored:, time:, data:, id: nil, scope:)
+      OpenC3.in_span("write") do
+        # Write to stream
+        msg_hash = {
+          :time => time,
+          :stored => stored.to_s,
+          :target_name => target_name,
+          :packet_name => packet_name,
+          :json_data => data,
+        }
+        topic = "#{scope}__REDUCED_DAY__{#{target_name}}__#{packet_name}"
+        offset = Topic.write_topic(topic, msg_hash, id)
+        return topic, offset
+      end
+    end
+  end
+end

data/lib/openc3/topics/telemetry_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 
@@ -23,8 +26,8 @@ module OpenC3
   class TelemetryTopic < Topic
     def self.write_packet(packet, scope:)
       msg_hash = {
-        :time => packet.received_time.to_nsec_from_epoch,
-        :stored => packet.stored,
+        :time => packet.packet_time.to_nsec_from_epoch,
+        :stored => packet.stored.to_s,
         :target_name => packet.target_name,
         :packet_name => packet.packet_name,
         :received_count => packet.received_count,

data/lib/openc3/topics/timeline_topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/topics/topic'
 

data/lib/openc3/topics/topic.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/utilities/store'
 

data/lib/openc3/utilities/authentication.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/version'
 

data/lib/openc3/utilities/authorization.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, 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/models/auth_model'