openc3-cosmos-demo 5.1.0 → 5.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3-cosmos-demo
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies: []
 description: |2
       This plugin adds the OpenC3 COSMOS demo configuration to a base OpenC3 COSMOS installation.
@@ -44,8 +44,10 @@ files:
 - targets/INST/procedures/collect.rb
 - targets/INST/procedures/disconnect.rb
 - targets/INST/procedures/file_dialog.rb
+- targets/INST/procedures/metadata.rb
 - targets/INST/procedures/my_script_suite.rb
 - targets/INST/procedures/my_test_suite.rb
+- targets/INST/procedures/stash.rb
 - targets/INST/procedures/target_file.rb
 - targets/INST/procedures/utilities/clear.rb
 - targets/INST/procedures/utilities/collect.rb
@@ -78,13 +80,6 @@ files:
 - targets/INST/tables/procedures/upload.rb
 - targets/INST/target.txt
 - targets/SYSTEM/cmd_tlm/limits_groups.txt
-- targets/SYSTEM/cmd_tlm/meta_tlm.txt
-- targets/SYSTEM/cmd_tlm/system_cmds.txt
-- targets/SYSTEM/cmd_tlm/system_tlm.txt
-- targets/SYSTEM/lib/example_background_task.rb
-- targets/SYSTEM/lib/example_target.rb
-- targets/SYSTEM/lib/limits_groups.rb
-- targets/SYSTEM/lib/scpi_target.rb
 - targets/SYSTEM/procedures/example_test.rb
 - targets/SYSTEM/procedures/interactive.rb
 - targets/SYSTEM/procedures/limits_api_test.rb

data/targets/SYSTEM/cmd_tlm/meta_tlm.txt

@@ -1,10 +0,0 @@
-TELEMETRY SYSTEM META BIG_ENDIAN "System Meta Data Telemetry Packet"
-  APPEND_ID_ITEM PKTID 8 UINT 1 "Packet Id"
-  APPEND_ITEM CONFIG 256 STRING "Configuration Name"
-  APPEND_ITEM OPENC3_VERSION 240 STRING "OpenC3 Version"
-    META READ_ONLY
-  APPEND_ITEM USER_VERSION 240 STRING "User Project Version"
-    META READ_ONLY
-  APPEND_ITEM RUBY_VERSION 240 STRING "Ruby Version"
-    META READ_ONLY
-  APPEND_ITEM OPERATOR_NAME 512 STRING "Operator Name"

data/targets/SYSTEM/cmd_tlm/system_cmds.txt

@@ -1,41 +0,0 @@
-COMMAND SYSTEM STARTLOGGING BIG_ENDIAN "Starts logging both commands and telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND SYSTEM STARTCMDLOG BIG_ENDIAN "Starts logging commands for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 3 3 3 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND SYSTEM STARTTLMLOG BIG_ENDIAN "Starts logging telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 4 4 4 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to start logging on - ALL starts logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND SYSTEM STOPLOGGING BIG_ENDIAN "Stops logging both commands and telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 5 5 5 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND SYSTEM STOPCMDLOG BIG_ENDIAN "Stops logging commands for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 6 6 6 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"
-
-COMMAND SYSTEM STOPTLMLOG BIG_ENDIAN "Stops logging telemetry for an interface"
-  APPEND_PARAMETER SYNC 32 UINT 0x1ACFFC1D 0x1ACFFC1D 0x1ACFFC1D "OpenC3 Command Sync Pattern"
-  APPEND_ID_PARAMETER OPCODE 32 UINT 7 7 7 "OpenC3 Command Opcode"
-  APPEND_PARAMETER LENGTH 32 UINT 0 65536 3 "OpenC3 Command Length of Command Data in Bytes"
-  APPEND_PARAMETER INTERFACE 256 STRING "ALL" "Interface to stop logging on - ALL stops logging on all interfaces"
-  APPEND_PARAMETER LABEL 0 STRING "" "Optional label to place on log files"

data/targets/SYSTEM/cmd_tlm/system_tlm.txt

@@ -1,7 +0,0 @@
-TELEMETRY SYSTEM LIMITS_CHANGE BIG_ENDIAN "OpenC3 limits change"
-  APPEND_ID_ITEM PKT_ID 8 UINT 2 "Packet Id"
-  APPEND_ITEM TARGET 240 STRING "Target name"
-  APPEND_ITEM PACKET 240 STRING "Packet name"
-  APPEND_ITEM ITEM 240 STRING "Item that changed limits state"
-  APPEND_ITEM OLD_STATE 240 STRING "The old limit state"
-  APPEND_ITEM NEW_STATE 240 STRING "The new limit state"

data/targets/SYSTEM/lib/example_background_task.rb

@@ -1,69 +0,0 @@
-# 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.
-
-# This file implements an example background task
-
-require 'openc3/tools/cmd_tlm_server/background_task'
-
-module OpenC3
-  # Starts by sleeping 5 seconds then sends up to three collect commands
-  class ExampleBackgroundTask < BackgroundTask
-    def initialize
-      super()
-      @name = 'Example Background Task'
-      # Create Sleeper here in case the task is stopped before call is executed
-      @sleeper = Sleeper.new
-    end
-
-    def call
-      sent_count = 0
-      @sleeper = Sleeper.new
-      @status = "Sleeping for 5 seconds"
-      return if @sleeper.sleep(5) # allow interfaces time to start
-      initial_count = tlm('INST', 'HEALTH_STATUS', 'COLLECTS')
-      loop do
-        # Start up with at least 3 collects
-        count = tlm('INST', 'HEALTH_STATUS', 'COLLECTS')
-        if count < (initial_count + 3)
-          begin
-            cmd('INST', 'COLLECT', 'TYPE' => 'NORMAL', 'DURATION' => 1)
-            sent_count += 1
-            @status = "Sent COLLECT ##{sent_count} at #{Time.now.sys.formatted}"
-            wait("INST HEALTH_STATUS COLLECTS > #{count}", 5)
-            @status = "Tlm Updated at #{Time.now.sys.formatted}"
-          rescue
-            # Oh well - probably disconnected
-          end
-        else
-          break
-        end
-        return if @sleeper.sleep(1)
-      end
-      @status = "Finished at #{Time.now.sys.formatted}"
-    end
-
-    def stop
-      @sleeper.cancel
-      @status = "Stopped at #{Time.now.sys.formatted}"
-    end
-  end
-end

data/targets/SYSTEM/lib/example_target.rb

@@ -1,115 +0,0 @@
-# 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'
-require 'openc3/interfaces'
-require 'openc3/tools/cmd_tlm_server/interface_thread'
-
-module OpenC3
-  class ExampleTarget
-    class ExampleServerInterface < TcpipServerInterface
-      PORT = 9999
-
-      def initialize
-        super(PORT, PORT, 5.0, nil, 'LENGTH', 0, 32, 4, 1, 'BIG_ENDIAN', 4, nil, nil, true)
-      end
-    end
-
-    class ExampleInterfaceThread < InterfaceThread
-      protected
-      def handle_packet(packet)
-        identified_packet = System.commands.identify(packet.buffer, ['EXAMPLE'])
-        if identified_packet
-          Logger.info "Received command: #{identified_packet.target_name} #{identified_packet.packet_name}"
-        else
-          Logger.info "Received UNKNOWN command"
-        end
-      end
-    end
-
-    class ExampleTelemetryThread
-      attr_reader :thread
-
-      def initialize(interface)
-        @interface = interface
-        @sleeper = Sleeper.new
-      end
-
-      def start
-        packet = System.telemetry.packet('EXAMPLE', 'STATUS')
-        @thread = Thread.new do
-          @stop_thread = false
-          begin
-            loop do
-              packet.write('PACKET_ID', 1)
-              packet.write('STRING', "The time is now: #{Time.now.sys.formatted}")
-              @interface.write(packet)
-              break if @sleeper.sleep(1)
-            end
-          rescue Exception => err
-            Logger.error "ExampleTelemetryThread unexpectedly died\n#{err.formatted}"
-          end
-        end
-      end
-
-      def stop
-        OpenC3.kill_thread(self, @thread)
-      end
-
-      def graceful_kill
-        @sleeper.cancel
-      end
-    end
-
-    def initialize
-      # Create interface to receive commands and send telemetry
-      @interface = ExampleServerInterface.new
-      @interface_thread = nil
-      @telemetry_thread = nil
-    end
-
-    def start
-      @interface_thread = ExampleInterfaceThread.new(@interface)
-      @interface_thread.start
-      @telemetry_thread = ExampleTelemetryThread.new(@interface)
-      @telemetry_thread.start
-    end
-
-    def stop
-      @telemetry_thread.stop if @telemetry_thread
-      @interface_thread.stop if @interface_thread
-    end
-
-    def self.run
-      Logger.level = Logger::INFO
-      target = self.new
-      begin
-        target.start
-        while true
-          sleep 1
-        end
-      rescue SystemExit, Interrupt
-        target.stop
-      end
-    end
-  end
-end

data/targets/SYSTEM/lib/limits_groups.rb

@@ -1,67 +0,0 @@
-# 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/tools/cmd_tlm_server/limits_groups_background_task'
-
-module OpenC3
-  # Inheriting from the LimitsGroupsBackgroundTask provides a framework for
-  # automatically enabling and disabling limits groups based on telemetry.
-  class LimitsGroups < LimitsGroupsBackgroundTask
-    def initialize(initial_delay = 0, task_delay = 0.5)
-      # Initial delay upon starting the server before staring the group checks
-      # followed by the background task delay between check iterations
-      super(initial_delay, task_delay)
-      # Creating a Proc allows for arbitrary code to be executed when a group
-      # is enabled or disabled.
-      @temp2_enable_code = Proc.new do
-        enable_limits_group('INST2_GROUND') # Enable the INST2_GROUND group
-      end
-      @temp2_disable_code = Proc.new do
-        disable_limits_group('INST2_GROUND') # Disable the INST2_GROUND group
-      end
-    end
-
-    # This method name is important. It must begin with 'check_' and end with
-    # the name of a Limits Group defined by the LIMITS_GROUP keyword. In the
-    # demo this is defined in config/targets/SYSTEM/cmd_tlm/limits_groups.txt.
-    # Note that there is a LIMITS_GROUP INST2_TEMP2 so we have a match.
-    def check_inst2_temp2
-      # Inside this method you must call process_group. The first parameter is
-      # the number of seconds to delay before enabling the group when the telemetry
-      # check is true. When the telemetry check is false the group is instantly
-      # disabled. The next two parameters are Proc objects which are called with
-      # the group is enabled and disabled respectively. We defined our Proc objects
-      # in the constructor to enable and disable the GROUND group.
-      process_group(0, @temp2_enable_code, @temp2_disable_code) do
-        val = tlm("INST2 HEALTH_STATUS TEMP2")
-        # The expression returns TRUE (to enable the group) when the value is
-        # not NAN  and not Infinite. If the value is NAN or Infinite the group
-        # is disabled. Note that this can't prevent false positives because the
-        # value has to change to something invalid before we can turn off the group
-        # at which point it is too late. Typically you enable or disable a group
-        # based on some external telemetry point such as a power supply output
-        # to enable a group of items powered by the supply.
-        !val.nan? && !val.infinite?
-      end
-    end
-  end
-end

data/targets/SYSTEM/lib/scpi_target.rb

@@ -1,79 +0,0 @@
-# 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'
-require 'openc3/interfaces'
-require 'openc3/tools/cmd_tlm_server/interface_thread'
-
-module OpenC3
-  class ScpiTarget
-    class ScpiServerInterface < TcpipServerInterface
-      PORT = 5025
-
-      def initialize
-        super(PORT, PORT, 5.0, nil, 'TERMINATED', '0xA', '0xA')
-      end
-    end
-
-    class ScpiInterfaceThread < InterfaceThread
-      def initialize(interface)
-        super(interface)
-        @index = 0
-      end
-
-      protected
-      def handle_packet(packet)
-        Logger.info "Received command: #{packet.buffer}"
-        if packet.buffer.include?('?')
-          @interface.write_raw(@index.to_s + "\x0A")
-        end
-        @index += 1
-      end
-    end
-
-    def initialize
-      # Create interface to receive commands and send telemetry
-      @target_interface = ScpiServerInterface.new
-      @interface_thread = nil
-    end
-
-    def start
-      @interface_thread = ScpiInterfaceThread.new(@target_interface)
-      @interface_thread.start
-    end
-
-    def stop
-      @interface_thread.stop if @interface_thread
-    end
-
-    def self.run
-      Logger.level = Logger::INFO
-      target = self.new
-      begin
-        target.start
-        loop { sleep 1 }
-      rescue SystemExit, Interrupt
-        target.stop
-      end
-    end
-  end
-end