openc3-demo 5.0.6

data/README.md

@@ -0,0 +1,30 @@
+## OpenC3 Demo Plugin
+
+[Documentation](https://openc3.com)
+
+This plugin provides a simple demo configuration for OpenC3 that shows off a lot of the features of OpenC3 and provides a test environment.
+
+## Getting Started
+
+1.  At the OpenC3 Admin - Plugins, upload the openc3-demo.gem file
+
+2. To build widgets run: yarn && yarn build
+
+## Contributing
+
+We encourage you to contribute to OpenC3!
+
+Contributing is easy.
+
+1. Fork the project
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+Before any contributions can be incorporated we do require all contributors to agree to a Contributor License Agreement.
+
+This protects both you and us and you retain full rights to any code you write.
+
+## License
+
+This OpenC3 plugin is released under the AGPLv3.0 with a few addendums. See [LICENSE.txt](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,42 @@
+# 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
+
+PLUGIN_NAME = Dir['*.gemspec'][0].split('.')[0..-2].join('.')
+
+task :require_version do
+  if ENV['VERSION']
+    if ENV['VERSION'] =~ /-/
+      # Add Timestamp to prerelease versions
+      ENV['VERSION'] = ENV['VERSION'] + "." + Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+  else
+    puts "VERSION is required: rake <task> VERSION=X.X.X"
+    exit 1
+  end
+end
+
+task :build => [:require_version] do
+  _, platform, *_ = RUBY_PLATFORM.split("-")
+  if platform == 'mswin32' or platform == 'mingw32'
+    puts "Warning: Building gem on Windows will lose file permissions"
+  end
+  # Build the widgets in the src directory
+  system("yarn run build")
+  system("gem build #{PLUGIN_NAME}")
+end

data/microservices/EXAMPLE/example_target.rb

@@ -0,0 +1,123 @@
+# 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
+
+require 'openc3'
+require 'openc3/interfaces'
+require 'openc3/tools/cmd_tlm_server/interface_thread'
+
+module OpenC3
+  class ExampleTarget
+    class ExampleServerInterface < TcpipServerInterface
+      def initialize(port)
+        super(port.to_i, port.to_i, 5.0, nil, 'LENGTH', 0, 32, 4, 1, 'BIG_ENDIAN', 4, nil, nil, true)
+      end
+    end
+
+    class ExampleInterfaceThread < InterfaceThread
+      attr_accessor :target_name
+
+      protected
+      def handle_packet(packet)
+        identified_packet = System.commands.identify(packet.buffer, [@target_name])
+        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, target_name)
+        @interface = interface
+        @target_name = target_name
+        @sleeper = Sleeper.new
+      end
+
+      def start
+        packet = System.telemetry.packet(@target_name, 'STATUS')
+        @thread = Thread.new do
+          @stop_thread = false
+          @sleeper.sleep(5)
+          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}"
+            raise err
+          end
+        end
+      end
+
+      def stop
+        OpenC3.kill_thread(self, @thread)
+      end
+
+      def graceful_kill
+        @sleeper.cancel
+      end
+    end
+
+    def initialize(target_name, port)
+      # Create interface to receive commands and send telemetry
+      @target_name = target_name
+      @interface = ExampleServerInterface.new(port)
+      @interface_thread = nil
+      @telemetry_thread = nil
+    end
+
+    def start
+      @interface_thread = ExampleInterfaceThread.new(@interface)
+      @interface_thread.target_name = @target_name
+      @interface_thread.start
+      @telemetry_thread = ExampleTelemetryThread.new(@interface, @target_name)
+      @telemetry_thread.start
+    end
+
+    def stop
+      @telemetry_thread.stop if @telemetry_thread
+      @interface_thread.stop if @interface_thread
+    end
+
+    def self.run(target_name, port)
+      Logger.level = Logger::INFO
+      Thread.abort_on_exception = true
+      temp_dir = Dir.mktmpdir
+      System.setup_targets([target_name], temp_dir, scope: ENV['OPENC3_SCOPE'])
+      target = self.new(target_name, port)
+      begin
+        target.start
+        while true
+          sleep 1
+        end
+      rescue SystemExit, Interrupt
+        target.stop
+        FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
+      end
+    end
+  end
+end
+
+OpenC3::ExampleTarget.run(ARGV[0], ARGV[1]) if __FILE__ == $0

data/microservices/TEMPLATED/scpi_target.rb

@@ -0,0 +1,79 @@
+# 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
+
+require 'openc3'
+require 'openc3/interfaces'
+require 'openc3/tools/cmd_tlm_server/interface_thread'
+
+module OpenC3
+  class ScpiTarget
+    class ScpiServerInterface < TcpipServerInterface
+      def initialize(port)
+        super(port.to_i, port.to_i, 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(port)
+      # Create interface to receive commands and send telemetry
+      @target_interface = ScpiServerInterface.new(port)
+      @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(target_name, port)
+      Logger.level = Logger::INFO
+      temp_dir = Dir.mktmpdir
+      System.setup_targets([target_name], temp_dir, scope: ENV['OPENC3_SCOPE'])
+      target = self.new(port)
+      begin
+        target.start
+        loop { sleep 1 }
+      rescue SystemExit, Interrupt
+        target.stop
+        FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
+      end
+    end
+  end
+end
+
+OpenC3::ScpiTarget.run(ARGV[0], ARGV[1]) if __FILE__ == $0

data/plugin.txt

@@ -0,0 +1,112 @@
+# Note: This plugin includes 4 targets in one plugin to make it easy to install
+# the OpenC3 demo with one plugin.  Generally it is better to only have one
+# target per plugin
+
+VARIABLE inst_target_name INST
+VARIABLE inst2_target_name INST2
+VARIABLE example_target_name EXAMPLE
+VARIABLE templated_target_name TEMPLATED
+VARIABLE system_target_name SYSTEM
+VARIABLE inst_int_name INST_INT
+VARIABLE inst_router_name INST_ROUTER
+VARIABLE inst2_int_name INST2_INT
+VARIABLE example_int_name EXAMPLE_INT
+VARIABLE templated_int_name TEMPLATED_INT
+VARIABLE demo_tool_name Demo
+VARIABLE example_microservice_name openc3-example
+VARIABLE templated_microservice_name openc3-templated
+VARIABLE example_port 9999
+VARIABLE templated_port 5025
+VARIABLE log_retain_time 172800
+VARIABLE reduced_log_retain_time 2592000
+
+<% include_inst = (inst_target_name.strip.length > 0) %>
+<% include_inst2 = (inst2_target_name.strip.length > 0) %>
+<% include_example = (example_target_name.strip.length > 0) %>
+<% include_templated = (templated_target_name.strip.length > 0) %>
+<% include_system = (system_target_name.strip.length > 0) %>
+<% include_inst_int = (inst_int_name.strip.length > 0) %>
+<% include_inst_router = (inst_router_name.strip.length > 0) %>
+<% include_inst2_int = (inst2_int_name.strip.length > 0) %>
+<% include_example_int = (example_int_name.strip.length > 0) %>
+<% include_templated_int = (templated_int_name.strip.length > 0) %>
+<% include_example_microservice = (example_microservice_name.strip.length > 0) %>
+<% include_templated_microservice = (templated_microservice_name.strip.length > 0) %>
+
+<% if include_inst %>
+  TARGET INST <%= inst_target_name %>
+    LOG_RETAIN_TIME <%= log_retain_time %>
+    REDUCED_LOG_RETAIN_TIME <%= reduced_log_retain_time %>
+    TLM_LOG_CYCLE_TIME 300
+<% end %>
+
+<% if include_inst2 %>
+  TARGET INST <%= inst2_target_name %>
+    LOG_RETAIN_TIME <%= log_retain_time %>
+    REDUCED_LOG_RETAIN_TIME <%= reduced_log_retain_time %>
+    TLM_LOG_CYCLE_TIME 600
+<% end %>
+
+<% if include_example %>
+  TARGET EXAMPLE <%= example_target_name %>
+    LOG_RETAIN_TIME <%= log_retain_time %>
+    REDUCED_LOG_RETAIN_TIME <%= reduced_log_retain_time %>
+<% end %>
+
+<% if include_templated %>
+  TARGET TEMPLATED <%= templated_target_name %>
+    LOG_RETAIN_TIME <%= log_retain_time %>
+    REDUCED_LOG_RETAIN_TIME <%= reduced_log_retain_time %>
+<% end %>
+
+<% if include_system %>
+  TARGET SYSTEM <%= system_target_name %>
+    LOG_RETAIN_TIME <%= log_retain_time %>
+    REDUCED_LOG_RETAIN_TIME <%= reduced_log_retain_time %>
+<% end %>
+
+<% if include_inst and include_inst_int %>
+  INTERFACE <%= inst_int_name %> simulated_target_interface.rb sim_inst.rb
+    MAP_TARGET <%= inst_target_name %>
+    PROTOCOL READ OverrideProtocol
+<% end %>
+
+<% if include_inst2 and include_inst2_int %>
+  INTERFACE <%= inst2_int_name %> simulated_target_interface.rb sim_inst.rb
+    MAP_TARGET <%= inst2_target_name %>
+    DONT_LOG
+    PROTOCOL READ_WRITE OverrideProtocol
+<% end %>
+
+<% if include_example and include_example_int %>
+  INTERFACE <%= example_int_name %> example_interface.rb openc3-operator <%= example_port %>
+    MAP_TARGET <%= example_target_name %>
+    DONT_CONNECT
+    LOG_RAW
+<% end %>
+
+<% if include_templated and include_templated_int %>
+  INTERFACE <%= templated_int_name %> templated_interface.rb openc3-operator <%= templated_port %> <%= templated_port %> 5.0 nil TEMPLATE 0xA 0xA
+    MAP_TARGET <%= templated_target_name %>
+    DONT_CONNECT
+<% end %>
+
+<% if include_inst and include_inst_router %>
+  ROUTER <%= inst_router_name %> tcpip_server_interface.rb 7779 7779 nil 10.0 PREIDENTIFIED
+    MAP_TARGET <%= inst_target_name %>
+<% end %>
+
+<% if include_example_microservice %>
+  MICROSERVICE EXAMPLE <%= example_microservice_name %>
+    WORK_DIR .
+    CMD ruby example_target.rb <%= example_target_name %> <%= example_port %>
+<% end %>
+
+<% if include_templated_microservice %>
+  MICROSERVICE TEMPLATED <%= templated_microservice_name %>
+    WORK_DIR .
+    CMD ruby scpi_target.rb <%= templated_target_name %> <%= templated_port %>
+<% end %>
+
+WIDGET BIG
+WIDGET HELLOWORLD

data/targets/EXAMPLE/cmd_tlm/example_cmds.txt

@@ -0,0 +1,2 @@
+COMMAND <%= target_name %> START BIG_ENDIAN "Starts something on the example target"
+  APPEND_ID_PARAMETER PACKET_ID 8 UINT 1 1 1 "Packet id"

data/targets/EXAMPLE/cmd_tlm/example_tlm.txt

@@ -0,0 +1,5 @@
+TELEMETRY <%= target_name %> STATUS BIG_ENDIAN "Health and status from the instrument"
+  APPEND_ID_ITEM PACKET_ID 8 UINT 1 "Packet id"
+  APPEND_ITEM VALUE 32 UINT "Limits value"
+    LIMITS DEFAULT 1 ENABLED 0 1 10 11
+  APPEND_ITEM STRING 0 STRING "Time string"

data/targets/EXAMPLE/lib/example_interface.rb

@@ -0,0 +1,27 @@
+# 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
+
+require 'openc3'
+require 'openc3/interfaces/tcpip_client_interface'
+
+class ExampleInterface < OpenC3::TcpipClientInterface
+  def initialize (hostname, port, write_timeout = 10.0, read_timeout = nil)
+    super(hostname, port, port, write_timeout, read_timeout, 'LENGTH', 0, 32, 4, 1, 'BIG_ENDIAN', 4, nil, nil, true)
+  end
+end

data/targets/EXAMPLE/target.txt

@@ -0,0 +1,9 @@
+REQUIRE example_interface.rb
+
+# Ignored Parameters
+# IGNORE_PARAMETER parameter_name
+IGNORE_PARAMETER PACKET_ID
+
+IGNORE_ITEM RECEIVED_COUNT
+IGNORE_ITEM RECEIVED_TIMESECONDS
+IGNORE_ITEM RECEIVED_TIMEFORMATTED

data/targets/INST/cmd_tlm/_ccsds_cmd.txt

@@ -0,0 +1,9 @@
+  PARAMETER    CCSDSVER        0   3  UINT  0     0   0 "CCSDS primary header version number"
+  PARAMETER    CCSDSTYPE       3   1  UINT  1     1   1 "CCSDS primary header packet type"
+  PARAMETER    CCSDSSHF        4   1  UINT  0     0   0 "CCSDS primary header secondary header flag"
+  ID_PARAMETER CCSDSAPID       5  11  UINT  0  2047 999 "CCSDS primary header application id"
+  PARAMETER    CCSDSSEQFLAGS  16   2  UINT  3     3   3 "CCSDS primary header sequence flags"
+  PARAMETER    CCSDSSEQCNT    18  14  UINT  0 16383   0 "CCSDS primary header sequence count"
+    OVERFLOW TRUNCATE
+  PARAMETER    CCSDSLENGTH    32  16  UINT MIN MAX 12 "CCSDS primary header packet length"
+  ID_PARAMETER PKTID          48  16  UINT MIN MAX <%= id %> "Packet id"

data/targets/INST/cmd_tlm/_ccsds_tlm.txt

@@ -0,0 +1,19 @@
+  APPEND_ITEM CCSDSVER      3 UINT   "CCSDS packet version number (See CCSDS 133.0-B-1)"
+  APPEND_ITEM CCSDSTYPE     1 UINT   "CCSDS packet type (command or telemetry)"
+    STATE TLM 0
+    STATE CMD 1
+  APPEND_ITEM CCSDSSHF      1 UINT   "CCSDS secondary header flag"
+    STATE FALSE 0
+    STATE TRUE 1
+  APPEND_ID_ITEM CCSDSAPID 11 UINT <%= apid %> "CCSDS application process id"
+  APPEND_ITEM CCSDSSEQFLAGS 2 UINT   "CCSDS sequence flags"
+    STATE FIRST 1
+    STATE CONT 0
+    STATE LAST 2
+    STATE NOGROUP 3
+  APPEND_ITEM CCSDSSEQCNT  14 UINT   "CCSDS packet sequence count"
+    OVERFLOW TRUNCATE
+  APPEND_ITEM CCSDSLENGTH  16 UINT   "CCSDS packet data length"
+  APPEND_ITEM TIMESEC      32 UINT   "Seconds since epoch (January 1st, 1970, midnight)"
+  APPEND_ITEM TIMEUS       32 UINT   "Microseconds of second"
+  APPEND_ID_ITEM PKTID     16 UINT 1 "Packet id (The combination of CCSDS_APID and PACKET_ID identify the packet)"

data/targets/INST/cmd_tlm/inst_cmds.txt

@@ -0,0 +1,57 @@
+COMMAND <%= target_name %> COLLECT BIG_ENDIAN "Starts a collect on the <%= target_name %> target"
+  <%= render "_ccsds_cmd.txt", locals: {id: 1} %>
+  PARAMETER    TYPE           64  16  UINT MIN MAX 0 "Collect type"
+    REQUIRED
+    STATE NORMAL  0
+    STATE SPECIAL 1 HAZARDOUS
+  PARAMETER    DURATION       80  32  FLOAT 0.0 10.0 1.0 "Collect duration"
+  PARAMETER    OPCODE        112   8  UINT 0x0 0xFF 0xAB "Collect opcode"
+    FORMAT_STRING "0x%0X"
+  PARAMETER    TEMP          120  32  FLOAT 0.0 25.0 0.0 "Collect temperature"
+    UNITS Celsius C
+
+COMMAND <%= target_name %> ABORT BIG_ENDIAN "Aborts a collect on the <%= target_name %> instrument"
+  <%= render "_ccsds_cmd.txt", locals: {id: 2} %>
+
+COMMAND <%= target_name %> CLEAR BIG_ENDIAN "Clears counters on the <%= target_name %> instrument"
+  HAZARDOUS "Clearing counters may lose valuable information."
+  <%= render "_ccsds_cmd.txt", locals: {id: 3} %>
+
+COMMAND <%= target_name %> SETPARAMS BIG_ENDIAN "Sets numbered parameters"
+  <%= render "_ccsds_cmd.txt", locals: {id: 4} %>
+  # ERB syntax:
+  <% (1..5).each do |i| %>
+    APPEND_PARAMETER VALUE<%= i %> 16 UINT 0 5 1 "Value <%= i %> setting"
+  <% end %>
+
+  SELECT_PARAMETER VALUE5
+    POLY_WRITE_CONVERSION 0 2
+
+COMMAND <%= target_name %> ASCIICMD BIG_ENDIAN "Enumerated ASCII command"
+  <%= render "_ccsds_cmd.txt", locals: {id: 5} %>
+  APPEND_PARAMETER STRING 2048 STRING "NOOP" "Enumerated string parameter"
+    STATE "NOOP" "NOOP"
+    STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser poses an eye safety hazard."
+    STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING Laser will be fired!"
+  APPEND_PARAMETER BINARY 32 STRING 0xDEADBEEF "Binary string"
+  APPEND_PARAMETER ASCII 80 STRING "0xDEADBEEF" "ASCII string"
+
+COMMAND <%= target_name %> FLTCMD BIG_ENDIAN "Command with float parameters"
+  <%= render "_ccsds_cmd.txt", locals: {id: 6} %>
+  PARAMETER    FLOAT32        64  32  FLOAT MIN MAX 0.0 "Float32 parameter"
+  PARAMETER    FLOAT64        96  64  FLOAT MIN MAX 0.0 "Float64 parameter"
+
+COMMAND <%= target_name %> ARYCMD BIG_ENDIAN "Command with array parameter"
+  <%= render "_ccsds_cmd.txt", locals: {id: 7} %>
+  ARRAY_PARAMETER ARRAY       64  32  UINT -8 "Array parameter"
+  PARAMETER    CRC            -8   8  UINT MIN MAX 0 "CRC"
+
+COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panels"
+  <%= render "_ccsds_cmd.txt", locals: {id: 8} %>
+
+COMMAND <%= target_name %> SLRPNLRESET BIG_ENDIAN "Reset solar array panels"
+  <%= render "_ccsds_cmd.txt", locals: {id: 9} %>
+
+COMMAND <%= target_name %> MEMLOAD BIG_ENDIAN "Load memory"
+  <%= render "_ccsds_cmd.txt", locals: {id: 10} %>
+  APPEND_PARAMETER DATA 80 BLOCK "" "Block of data"