openc3-cosmos-demo 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23530204cfaedbd0c8ae5eb0af5a696e83da0bb20c838f0f291c7f0012dea548
-  data.tar.gz: 1fd70065638e1fd360247607715766fc7a300015de033eed33a6a61823349ba6
+  metadata.gz: 235a69629911dd8dc15706733821bf9312faeac565ad81973054a3b44c021df3
+  data.tar.gz: 92ba9c815129d51a34972c607307b58f17243c72a955d6e1e70c6c84f6af9678
 SHA512:
-  metadata.gz: 4357fd9b36217037c237d6b09925570e836169c6c188089590886df46fc97faf501db34743620f945fcdee6f541c0c7c32eb3135d898ab8199393ca1543d9db7
-  data.tar.gz: 01e244d8ffd4504e09ee54058dd7b6b8f457bec4bf0824751c3dfb71f2097355cc17bbc254835078a1217f33c1af1ab45a56ac3a6ed9d213b9fbc8c663cc3250
+  metadata.gz: b1dc661ba5354a53f4b1fed8e9291ea31b1571a145554f4b69d8c90611f24dc62654557ef16b3553f66b2e580dd7d906bf34fe57e5c0578495899f5797538a0b
+  data.tar.gz: c7bbcbb72693194a7cce38991161bbec89849d1f8bcb0eae26eaf85b9536c01a294fd2af8faa9ab7dfe7839472e1610e36fb1debdefba14475281b9c8c5bd420

data/microservices/EXAMPLE/example_target.rb

@@ -22,10 +22,11 @@
 
 require 'openc3'
 require 'openc3/interfaces'
+require 'openc3/microservices/microservice'
 require 'openc3/tools/cmd_tlm_server/interface_thread'
 
 module OpenC3
-  class ExampleTarget
+  class ExampleTarget < Microservice
     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)
@@ -83,9 +84,15 @@ module OpenC3
       end
     end
 
-    def initialize(target_name, port)
+    def initialize(name)
+      super(name)
+      @sleep_period = 1 # 1 second between runs
+      # @target_names is an array of all the names mapped to this microservice
+      @target_name = @target_names[0] # Should only be 1
+      # ports is an array of arrays consisting of the port number and protocol
+      # e.g. [[1234, "UDP"], [5678, "TCP"]]
+      port = @config["ports"][0][0] # Should only be 1
       # Create interface to receive commands and send telemetry
-      @target_name = target_name
       @interface = ExampleServerInterface.new(port)
       @interface_thread = nil
       @telemetry_thread = nil
@@ -104,23 +111,22 @@ module OpenC3
       @interface_thread.stop if @interface_thread
     end
 
-    def self.run(target_name, port)
+    def run
       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, SignalException
-        target.stop
-        FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
+
+      @state = 'STARTING'
+      start()
+      @state = 'RUNNING'
+      while true
+        break if @cancel_thread
+        sleep @sleep_period
       end
+      @state = 'STOPPING'
+      stop()
+      @state = 'STOPPED'
     end
   end
 end
 
-OpenC3::ExampleTarget.run(ARGV[0], ARGV[1]) if __FILE__ == $0
+OpenC3::ExampleTarget.run if __FILE__ == $0

data/microservices/TEMPLATED/scpi_target.rb

@@ -22,10 +22,11 @@
 
 require 'openc3'
 require 'openc3/interfaces'
+require 'openc3/microservices/microservice'
 require 'openc3/tools/cmd_tlm_server/interface_thread'
 
 module OpenC3
-  class ScpiTarget
+  class ScpiTarget < Microservice
     class ScpiServerInterface < TcpipServerInterface
       def initialize(port)
         super(port.to_i, port.to_i, 5.0, nil, 'TERMINATED', '0xA', '0xA')
@@ -48,7 +49,12 @@ module OpenC3
       end
     end
 
-    def initialize(port)
+    def initialize(name)
+      super(name)
+      @sleep_period = 1 # 1 second between runs
+      # ports is an array of arrays consisting of the port number and protocol
+      # e.g. [[1234, "UDP"], [5678, "TCP"]]
+      port = @config["ports"][0][0] # Should only be 1
       # Create interface to receive commands and send telemetry
       @target_interface = ScpiServerInterface.new(port)
       @interface_thread = nil
@@ -63,20 +69,22 @@ module OpenC3
       @interface_thread.stop if @interface_thread
     end
 
-    def self.run(target_name, port)
+    def run
       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, SignalException
-        target.stop
-        FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
+      Thread.abort_on_exception = true
+
+      @state = 'STARTING'
+      start()
+      @state = 'RUNNING'
+      while true
+        break if @cancel_thread
+        sleep @sleep_period
       end
+      @state = 'STOPPING'
+      stop()
+      @state = 'STOPPED'
     end
   end
 end
 
-OpenC3::ScpiTarget.run(ARGV[0], ARGV[1]) if __FILE__ == $0
+OpenC3::ScpiTarget.run if __FILE__ == $0

data/plugin.txt

@@ -23,18 +23,18 @@ VARIABLE inst_router_port 7779
 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) %>
+<% include_inst = (inst_target_name.to_s.strip.length > 0) %>
+<% include_inst2 = (inst2_target_name.to_s.strip.length > 0) %>
+<% include_example = (example_target_name.to_s.strip.length > 0) %>
+<% include_templated = (templated_target_name.to_s.strip.length > 0) %>
+<% include_system = (system_target_name.to_s.strip.length > 0) %>
+<% include_inst_int = (inst_int_name.to_s.strip.length > 0) %>
+<% include_inst_router = (inst_router_name.to_s.strip.length > 0) %>
+<% include_inst2_int = (inst2_int_name.to_s.strip.length > 0) %>
+<% include_example_int = (example_int_name.to_s.strip.length > 0) %>
+<% include_templated_int = (templated_int_name.to_s.strip.length > 0) %>
+<% include_example_microservice = (example_microservice_name.to_s.strip.length > 0) %>
+<% include_templated_microservice = (templated_microservice_name.to_s.strip.length > 0) %>
 
 <% if include_inst %>
   TARGET INST <%= inst_target_name %>
@@ -69,14 +69,12 @@ VARIABLE reduced_log_retain_time 2592000
 <% 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 %>
@@ -99,16 +97,16 @@ VARIABLE reduced_log_retain_time 2592000
 
 <% if include_example_microservice %>
   MICROSERVICE EXAMPLE <%= example_microservice_name %>
-    WORK_DIR .
+    CMD ruby example_target.rb
+    TARGET_NAME <%= example_target_name %>
     PORT <%= example_port %>
-    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
+    TARGET_NAME <%= templated_target_name %>
     PORT <%= templated_port %>
-    CMD ruby scpi_target.rb <%= templated_target_name %> <%= templated_port %>
 <% end %>
 
 WIDGET BIG

data/targets/INST/cmd_tlm/inst_cmds.txt

@@ -30,9 +30,9 @@ COMMAND <%= target_name %> SETPARAMS BIG_ENDIAN "Sets numbered parameters"
 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" DISABLE_MESSAGES
     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!"
+    STATE "NOOP" "NOOP" DISABLE_MESSAGES
   APPEND_PARAMETER BINARY 32 STRING 0xDEADBEEF "Binary string"
   APPEND_PARAMETER ASCII 80 STRING "0xDEADBEEF" "ASCII string"
 
@@ -59,7 +59,7 @@ COMMAND <%= target_name %> MEMLOAD BIG_ENDIAN "Load memory"
 
 COMMAND <%= target_name %> QUIET BIG_ENDIAN "Enable/disable no out of limits in the demo"
   <%= render "_ccsds_cmd.txt", locals: {id: 11} %>
-  APPEND_PARAMETER STATE 8 UINT 0 1 0
+  APPEND_PARAMETER STATE 8 UINT 0 1 1
     STATE FALSE 0
     STATE TRUE 1
 

data/targets/INST/lib/sim_inst.rb

@@ -368,7 +368,7 @@ module OpenC3
 
       # Every 10s throw an unknown packet at the server just to demo that
       data = Array.new(10) { rand(0..255) }.pack("C*")
-      if @get_count % 1000 == 999
+      if @get_count % 1000 == 900
         pending_packets << Packet.new(nil, nil, :BIG_ENDIAN, nil, data)
       end
 

data/targets/INST/procedures/disconnect.rb

@@ -7,23 +7,15 @@ cmd_raw_no_range_check("<%= target_name %> COLLECT with TYPE 0, TEMP 100")
 cmd_raw_no_hazardous_check("<%= target_name %> CLEAR")
 cmd_raw_no_checks("<%= target_name %> COLLECT with TYPE 1, TEMP 100.0")
 check("<%= target_name %> ADCS BIASX == 100")
-check_formatted("<%= target_name %> ADCS BIASX == 100")
-check_with_units("<%= target_name %> ADCS BIASX == 100")
-check_raw("<%= target_name %> ADCS BIASX == 100")
 check_tolerance("<%= target_name %> ADCS BIASX", 5, 0.5)
-check_tolerance_raw("<%= target_name %> ADCS BIASX", 5, 0.5)
 check_expression("true == false")
 wait
 wait 5
 wait("<%= target_name %> ADCS BIASX > 100", 5)
-wait_raw("<%= target_name %> ADCS BIASX > 100", 5)
 wait_tolerance("<%= target_name %> ADCS BIASX", 5, 0.5, 5)
-wait_tolerance_raw("<%= target_name %> ADCS BIASX", 5, 0.5, 5)
 wait_expression("true == false", 5)
 wait_packet("<%= target_name %>","ADCS", 2, 5)
 wait_check("<%= target_name %> ADCS BIASX == 100", 5)
-wait_check_raw("<%= target_name %> ADCS BIASX == 100", 5)
 wait_check_tolerance("<%= target_name %> ADCS BIASX", 5, 0.5, 5)
-wait_check_tolerance_raw("<%= target_name %> ADCS BIASX", 5, 0.5, 5)
 wait_check_expression("true == false", 5)
 wait_check_packet("<%= target_name %>","ADCS", 2, 5)

data/targets/SYSTEM/procedures/openc3_api_test.rb

@@ -176,11 +176,19 @@ tlm("INST HEALTH_STATUS ARY")
 tlm("INST HEALTH_STATUS ASCIICMD")
 tlm("INST HEALTH_STATUS CCSDSAPID")
 tlm("INST HEALTH_STATUS TEMP1")
+tlm("INST HEALTH_STATUS TEMP1", type: :RAW)
+tlm("INST HEALTH_STATUS TEMP1", type: :CONVERTED)
+tlm("INST HEALTH_STATUS TEMP1", type: :FORMATTED)
+tlm("INST HEALTH_STATUS TEMP1", type: :WITH_UNITS)
 
 tlm("INST", "HEALTH_STATUS", "ARY")
 tlm("INST", "HEALTH_STATUS", "ASCIICMD")
 tlm("INST", "HEALTH_STATUS", "CCSDSAPID")
 tlm("INST", "HEALTH_STATUS", "TEMP1")
+tlm("INST", "HEALTH_STATUS", "TEMP1", type: :RAW)
+tlm("INST", "HEALTH_STATUS", "TEMP1", type: :CONVERTED)
+tlm("INST", "HEALTH_STATUS", "TEMP1", type: :FORMATTED)
+tlm("INST", "HEALTH_STATUS", "TEMP1", type: :WITH_UNITS)
 
 # tlm should fail
 tlm()
@@ -195,92 +203,27 @@ tlm("INST", "HEALTH_STATUS")
 tlm("INST", "HEALTH_STATUS", "BOB")
 tlm("INST", "HEALTH_STATUS", "ARY", "BOB")
 
-# tlm_raw
-tlm_raw("INST HEALTH_STATUS ARY")
-tlm_raw("INST HEALTH_STATUS ASCIICMD")
-tlm_raw("INST HEALTH_STATUS CCSDSAPID")
-tlm_raw("INST HEALTH_STATUS TEMP1")
-
-tlm_raw("INST", "HEALTH_STATUS", "ARY")
-tlm_raw("INST", "HEALTH_STATUS", "ASCIICMD")
-tlm_raw("INST", "HEALTH_STATUS", "CCSDSAPID")
-tlm_raw("INST", "HEALTH_STATUS", "TEMP1")
-
-# tlm_raw should fail
-tlm_raw()
-tlm_raw("BOB")
-tlm_raw("INST")
-tlm_raw("INST BOB")
-tlm_raw("INST HEALTH_STATUS")
-tlm_raw("INST HEALTH_STATUS BOB")
-tlm_raw("INST HEALTH_STATUS ARY BOB")
-tlm_raw("INST", "BOB")
-tlm_raw("INST", "HEALTH_STATUS")
-tlm_raw("INST", "HEALTH_STATUS", "BOB")
-tlm_raw("INST", "HEALTH_STATUS", "ARY", "BOB")
-
-# tlm_formatted
-tlm_formatted("INST HEALTH_STATUS ARY")
-tlm_formatted("INST HEALTH_STATUS ASCIICMD")
-tlm_formatted("INST HEALTH_STATUS CCSDSAPID")
-tlm_formatted("INST HEALTH_STATUS TEMP1")
-
-tlm_formatted("INST", "HEALTH_STATUS", "ARY")
-tlm_formatted("INST", "HEALTH_STATUS", "ASCIICMD")
-tlm_formatted("INST", "HEALTH_STATUS", "CCSDSAPID")
-tlm_formatted("INST", "HEALTH_STATUS", "TEMP1")
-
-# tlm_formatted should fail
-tlm_formatted()
-tlm_formatted("BOB")
-tlm_formatted("INST")
-tlm_formatted("INST BOB")
-tlm_formatted("INST HEALTH_STATUS")
-tlm_formatted("INST HEALTH_STATUS BOB")
-tlm_formatted("INST HEALTH_STATUS ARY BOB")
-tlm_formatted("INST", "BOB")
-tlm_formatted("INST", "HEALTH_STATUS")
-tlm_formatted("INST", "HEALTH_STATUS", "BOB")
-tlm_formatted("INST", "HEALTH_STATUS", "ARY", "BOB")
-
-# tlm_with_units
-tlm_with_units("INST HEALTH_STATUS ARY")
-tlm_with_units("INST HEALTH_STATUS ASCIICMD")
-tlm_with_units("INST HEALTH_STATUS CCSDSAPID")
-tlm_with_units("INST HEALTH_STATUS TEMP1")
-
-tlm_with_units("INST", "HEALTH_STATUS", "ARY")
-tlm_with_units("INST", "HEALTH_STATUS", "ASCIICMD")
-tlm_with_units("INST", "HEALTH_STATUS", "CCSDSAPID")
-tlm_with_units("INST", "HEALTH_STATUS", "TEMP1")
-
-# tlm_with_units should fail
-tlm_with_units()
-tlm_with_units("BOB")
-tlm_with_units("INST")
-tlm_with_units("INST BOB")
-tlm_with_units("INST HEALTH_STATUS")
-tlm_with_units("INST HEALTH_STATUS BOB")
-tlm_with_units("INST HEALTH_STATUS ARY BOB")
-tlm_with_units("INST", "BOB")
-tlm_with_units("INST", "HEALTH_STATUS")
-tlm_with_units("INST", "HEALTH_STATUS", "BOB")
-tlm_with_units("INST", "HEALTH_STATUS", "ARY", "BOB")
-
 # override_tlm
 override_tlm("INST HEALTH_STATUS ARY = [0,0,0,0,0,0,0,0,0,0]")
 override_tlm("INST HEALTH_STATUS ASCIICMD = 'HI'")
 override_tlm("INST HEALTH_STATUS CCSDSAPID = 1000")
 override_tlm("INST HEALTH_STATUS TEMP1 = 15")
+data = Array.new(131072 / 8) { rand(0..255) }.pack("C*")
+override_tlm("INST", "IMAGE", "IMAGE", data)
 
-# override_tlm_raw
-override_tlm_raw("INST HEALTH_STATUS ARY = [0,0,0,0,0,0,0,0,0,0]")
-override_tlm_raw("INST HEALTH_STATUS ASCIICMD = 'HI'")
-override_tlm_raw("INST HEALTH_STATUS CCSDSAPID = 1000")
-override_tlm_raw("INST HEALTH_STATUS TEMP1 = 10000")
+wait_check("INST HEALTH_STATUS ARY == [1,2,3]", 5)
+wait_check("INST HEALTH_STATUS ASCIICMD == 'HI'", 5)
+wait_check("INST HEALTH_STATUS CCSDSAPID == 1000", 5)
+wait_check("INST HEALTH_STATUS TEMP1 == 15", 5)
 
 # normalize_tlm
 normalize_tlm("INST HEALTH_STATUS ARY")
 normalize_tlm("INST HEALTH_STATUS ASCIICMD")
 normalize_tlm("INST HEALTH_STATUS CCSDSAPID")
 normalize_tlm("INST HEALTH_STATUS TEMP1")
+normalize_tlm("INST IMAGE IMAGE")
+
+wait_check("INST HEALTH_STATUS ARY != [1,2,3]", 5)
+wait_check("INST HEALTH_STATUS ASCIICMD != 'HI'", 5)
+wait_check("INST HEALTH_STATUS CCSDSAPID != 1000", 5)
+wait_check("INST HEALTH_STATUS TEMP1 != 15", 5)