openc3-cosmos-demo 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b638bf65f2ccd2439642ff31e0210e78f64787919710c039e2f6042909c799
-  data.tar.gz: 5fdd46b6a6e73e03e611c3b3d9ef34b007d564f185c9fdb0484b9013d2f5ced6
+  metadata.gz: 23530204cfaedbd0c8ae5eb0af5a696e83da0bb20c838f0f291c7f0012dea548
+  data.tar.gz: 1fd70065638e1fd360247607715766fc7a300015de033eed33a6a61823349ba6
 SHA512:
-  metadata.gz: 51f9f7a860215c53224d50555e910b0bfffe8350d5b06e33af3cd559b6b43d3c202d5653568c8445db966c8b47a1431e0a15434f2855d1b777754ad75fcc32e1
-  data.tar.gz: 93f6a8b8d1c8cfa230b5312ae91d199e64aa7fb964a703e01d4d3676f027dc0f664bfdb9ca51befe03552445fd58d48ce59281093e2a5abf945219a799559ebe
+  metadata.gz: 4357fd9b36217037c237d6b09925570e836169c6c188089590886df46fc97faf501db34743620f945fcdee6f541c0c7c32eb3135d898ab8199393ca1543d9db7
+  data.tar.gz: 01e244d8ffd4504e09ee54058dd7b6b8f457bec4bf0824751c3dfb71f2097355cc17bbc254835078a1217f33c1af1ab45a56ac3a6ed9d213b9fbc8c663cc3250

data/microservices/EXAMPLE/example_target.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'
@@ -115,7 +115,7 @@ module OpenC3
         while true
           sleep 1
         end
-      rescue SystemExit, Interrupt
+      rescue SystemExit, SignalException
         target.stop
         FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
       end

data/microservices/TEMPLATED/scpi_target.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'
@@ -71,7 +71,7 @@ module OpenC3
       begin
         target.start
         loop { sleep 1 }
-      rescue SystemExit, Interrupt
+      rescue SystemExit, SignalException
         target.stop
         FileUtils.remove_entry(temp_dir) if File.exist?(temp_dir)
       end

data/plugin.txt

@@ -64,8 +64,6 @@ VARIABLE reduced_log_retain_time 2592000
 
 <% 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 %>

data/targets/INST/cmd_tlm/inst_cmds.txt

@@ -30,7 +30,7 @@ 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"
+    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!"
   APPEND_PARAMETER BINARY 32 STRING 0xDEADBEEF "Binary string"
@@ -53,6 +53,7 @@ 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"
+  DISABLE_MESSAGES # Disable messages on a command that could be sent many many times
   <%= render "_ccsds_cmd.txt", locals: {id: 10} %>
   APPEND_PARAMETER DATA 80 BLOCK "" "Block of data"
 
@@ -61,3 +62,7 @@ COMMAND <%= target_name %> QUIET BIG_ENDIAN "Enable/disable no out of limits in
   APPEND_PARAMETER STATE 8 UINT 0 1 0
     STATE FALSE 0
     STATE TRUE 1
+
+COMMAND <%= target_name %> TIME_OFFSET BIG_ENDIAN "Subtract the packet time by the given seconds"
+  <%= render "_ccsds_cmd.txt", locals: {id: 12} %>
+  APPEND_PARAMETER SECONDS 32 UINT MIN MAX 0 "Seconds to subtract from packet time"

data/targets/INST/cmd_tlm/inst_tlm.txt

@@ -49,11 +49,8 @@ TELEMETRY <%= target_name %> HEALTH_STATUS BIG_ENDIAN "Health and status from th
     STATE CONNECTED 1 GREEN
     STATE UNAVAILABLE 0 YELLOW
   APPEND_ITEM BLOCKTEST 80 BLOCK "Block data"
-  ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
-    READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
-    FORMAT_STRING '%0.6f'
-  ITEM TIMEFORMATTED 0 0 DERIVED "Derived time since epoch as formatted string"
-    READ_CONVERSION unix_time_formatted_conversion.rb TIMESEC TIMEUS
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
   ITEM TEMP1HIGH 0 0 DERIVED "High-water mark for TEMP1"
     READ_CONVERSION processor_conversion.rb TEMP1WATER HIGH_WATER
   ITEM TEMP1LOW 0 0 DERIVED "Low-water mark for TEMP1"
@@ -109,11 +106,8 @@ TELEMETRY <%= target_name %> ADCS BIG_ENDIAN "Position and attitude data"
     FORMAT_STRING "%0.2f"
   ITEM ATTPROGRESS      656 32 FLOAT "Attitude file progress"
     FORMAT_STRING "%0.2f"
-  ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
-    READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
-    FORMAT_STRING '%0.6f'
-  ITEM TIMEFORMATTED 0 0 DERIVED "Derived time since epoch as formatted string"
-    READ_CONVERSION unix_time_formatted_conversion.rb TIMESEC TIMEUS
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
 
 TELEMETRY <%= target_name %> PARAMS BIG_ENDIAN "Params set by SETPARAMS command"
   <%= render "_ccsds_tlm.txt", locals: {apid: 3} %>
@@ -123,12 +117,8 @@ TELEMETRY <%= target_name %> PARAMS BIG_ENDIAN "Params set by SETPARAMS command"
       STATE GOOD 0 GREEN
       STATE BAD 1 RED
   <% end %>
-
-  ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
-    READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
-    FORMAT_STRING '%0.6f'
-  ITEM TIMEFORMATTED 0 0 DERIVED "Derived time since epoch as formatted string"
-    READ_CONVERSION unix_time_formatted_conversion.rb TIMESEC TIMEUS
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
 
 TELEMETRY <%= target_name %> IMAGE BIG_ENDIAN "Packet with image data"
   <%= render "_ccsds_tlm.txt", locals: {apid: 4} %>
@@ -136,11 +126,8 @@ TELEMETRY <%= target_name %> IMAGE BIG_ENDIAN "Packet with image data"
     FORMAT_STRING '0x%08x'
   ITEM IMAGE 128 131072 BLOCK   "10x10 Image Data"
     OVERLAP # Notify OpenC3 that this is intentionally overlapping the BYTES field
-  ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
-    READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
-    FORMAT_STRING '%0.6f'
-  ITEM TIMEFORMATTED 0 0 DERIVED "Derived time since epoch as formatted string"
-    READ_CONVERSION unix_time_formatted_conversion.rb TIMESEC TIMEUS
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
 
 TELEMETRY <%= target_name %> MECH BIG_ENDIAN "Mechanism status"
   <%= render "_ccsds_tlm.txt", locals: {apid: 5} %>
@@ -155,8 +142,5 @@ TELEMETRY <%= target_name %> MECH BIG_ENDIAN "Mechanism status"
     UNITS DEGREES DEG
   APPEND_ITEM SLRPNL5       32 FLOAT    "Solar panel 5 angle"
     UNITS DEGREES DEG
-  ITEM TIMESECONDS 0 0 DERIVED "Derived floating-point time since epoch in seconds"
-    READ_CONVERSION unix_time_seconds_conversion.rb TIMESEC TIMEUS
-    FORMAT_STRING '%0.6f'
-  ITEM TIMEFORMATTED 0 0 DERIVED "Derived time since epoch as formatted string"
-    READ_CONVERSION unix_time_formatted_conversion.rb TIMESEC TIMEUS
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS

data/targets/INST/lib/sim_inst.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.
 
 # Provides a demonstration of a Simulated Target
@@ -132,6 +132,7 @@ module OpenC3
       @bad_temp2 = false
       @last_temp2 = 0
       @quiet = false
+      @time_offset = 0
     end
 
     def set_rates
@@ -171,6 +172,8 @@ module OpenC3
         else
           @quiet = false
         end
+      when 'TIME_OFFSET'
+        @time_offset = packet.read('seconds')
       when 'SETPARAMS'
         params_packet.value1 = packet.read('value1')
         params_packet.value2 = packet.read('value2')
@@ -274,7 +277,7 @@ module OpenC3
           packet.posprogress = (@position_file_bytes_read.to_f / @position_file_size.to_f) * 100.0
           packet.attprogress = (@attitude_file_bytes_read.to_f / @attitude_file_size.to_f) * 100.0
 
-          packet.timesec = time.tv_sec
+          packet.timesec = time.tv_sec - @time_offset
           packet.timeus  = time.tv_usec
           packet.ccsdsseqcnt += 1
 
@@ -291,7 +294,7 @@ module OpenC3
               @bad_temp2 = false
             end
             @last_temp2 = cycle_tlm_item(packet, 'temp2', -50.0, 50.0, -1.0)
-              if (packet.temp2.abs - 30).abs < 2
+            if (packet.temp2.abs - 30).abs < 2
               packet.write('temp2', Float::NAN)
               @bad_temp2 = true
             elsif (packet.temp2.abs - 20).abs < 2
@@ -305,7 +308,7 @@ module OpenC3
           end
           cycle_tlm_item(packet, 'temp4', 0.0, 20.0, -0.1)
 
-          packet.timesec = time.tv_sec
+          packet.timesec = time.tv_sec - @time_offset
           packet.timeus  = time.tv_usec
           packet.ccsdsseqcnt += 1
 
@@ -337,12 +340,12 @@ module OpenC3
           end
 
         when 'PARAMS'
-          packet.timesec = time.tv_sec
+          packet.timesec = time.tv_sec - @time_offset
           packet.timeus = time.tv_usec
           packet.ccsdsseqcnt += 1
 
         when 'IMAGE'
-          packet.timesec = time.tv_sec
+          packet.timesec = time.tv_sec - @time_offset
           packet.timeus = time.tv_usec
           # Create an Array the size of the packet and then initialize
           # using a sample of all possible hex values (0..15)
@@ -352,7 +355,7 @@ module OpenC3
           packet.ccsdsseqcnt += 1
 
         when 'MECH'
-          packet.timesec = time.tv_sec
+          packet.timesec = time.tv_sec - @time_offset
           packet.timeus = time.tv_usec
           packet.ccsdsseqcnt += 1
           packet.slrpnl1 = @solar_panel_positions[0]

data/targets/INST/procedures/checks.rb

@@ -1,3 +1,6 @@
+# Display the environment variables
+puts ENV.inspect
+
 collect_cnt = tlm("<%= target_name %> HEALTH_STATUS COLLECTS")
 cmd("<%= target_name %> COLLECT with DURATION 11, TYPE NORMAL")
 cmd_no_range_check("<%= target_name %> COLLECT with DURATION 11, TYPE NORMAL")

data/targets/INST/procedures/metadata.rb

@@ -0,0 +1,22 @@
+# Example of using metadata. Note each call to metadata_set creates a new entry.
+# metadata_update without a start time will update the latest metadata entry.
+puts metadata_get()
+puts metadata_set({ 'setkey' => 1 })
+check_expression("#{metadata_all().length} >= 1")
+check_expression("#{metadata_get()['metadata']} == {\"setkey\"=>1}")
+puts metadata_get()['metadata']
+puts metadata_update({ 'setkey' => 2, 'updatekey' => 3 })
+check_expression("#{metadata_get()['metadata']['setkey']} == 2")
+check_expression("#{metadata_get()['metadata']['updatekey']} == 3")
+puts metadata_update({ 'setkey' => 4 }) # Ensure updatekey stays
+check_expression("#{metadata_get()['metadata']['setkey']} == 4")
+check_expression("#{metadata_get()['metadata']['updatekey']} == 3")
+check_expression("#{metadata_all().length} >= 1")
+metadata_input() # Creates a new entry
+check_expression("#{metadata_all().length} >= 2")
+wait 2 # Allow time to advance or it's an error
+metadata_set({ 'new' => 5 }) # Another new entry
+check_expression("#{metadata_all().length} >= 3")
+# The first entry is the newest one we created
+puts metadata_all
+check_expression("#{metadata_all()[0]['metadata']} == {\"new\"=>5}")

data/targets/INST/procedures/stash.rb

@@ -0,0 +1,22 @@
+# Stash API is useful for storing simple key/value pairs
+# to preserve state between script runs
+stash_set('key1', 'val1')
+stash_set('key2', 'val2')
+check_expression("'#{stash_get('key1')}' == 'val1'")
+check_expression("'#{stash_get('key2')}' == 'val2'")
+check_expression("'#{stash_keys().to_s}' == '[\"key1\", \"key2\"]'")
+stash_set('key1', 1)
+stash_set('key2', 2)
+check_expression("'#{stash_all().to_s}' == '{\"key1\"=>1, \"key2\"=>2}'")
+stash_delete('key2')
+check_expression("#{stash_get('key2').nil?} == true")
+stash_delete('key1')
+data = [1,2,[3,4]]
+stash_set('ary', data)
+check_expression("'#{stash_get('ary')}' == '#{data.to_s}'")
+stash_delete('ary')
+# Note: hashes with symbol keys works but get converted to string keys on stash_get
+hash = { 'one' => 1, 'two' => 2, 'string' => 'string' }
+stash_set('hash', hash)
+check_expression("'#{stash_get('hash')}' == '#{hash.to_s}'")
+stash_delete('hash')

data/targets/INST/screens/_footer.txt

@@ -1,3 +1,3 @@
 VERTICALBOX
-  LABELVALUE <%= target_name %> HEALTH_STATUS TIMEFORMATTED WITH_UNITS 30
+  LABELVALUE <%= target_name %> HEALTH_STATUS PACKET_TIMEFORMATTED WITH_UNITS 30
 END

data/targets/INST/screens/adcs.txt

@@ -66,6 +66,6 @@ VERTICAL
   END
 
   VERTICALBOX
-    LABELVALUE <%= target_name %> ADCS TIMEFORMATTED WITH_UNITS 30
+    LABELVALUE <%= target_name %> ADCS PACKET_TIMEFORMATTED WITH_UNITS 30
   END
 END

data/targets/INST/screens/commanding.txt

@@ -11,7 +11,9 @@ VERTICAL
     SECTIONHEADER "Send Collect Command:"
     HORIZONTAL
       LABEL "Type: "
-      NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL
+      # The ampersand '&' indicates a line continuation
+      NAMED_WIDGET COLLECT_TYPE &
+        COMBOBOX NORMAL SPECIAL
     END
     HORIZONTAL
       LABEL "  Duration: "
@@ -22,7 +24,12 @@ VERTICAL
     # Note: you can also request and use telemetry in screens using Javascript Promises, e.g.
     # api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE '+type+', DURATION '+dur))"
     # The tlm() function returns a Promise which is resolved with then() at which point we send the command with the parameter
-    BUTTON 'Start Collect' "var type=screen.getNamedWidget('COLLECT_TYPE').text(); api.cmd('<%= target_name %> COLLECT with TYPE '+type+', DURATION '+screen.getNamedWidget('DURATION').text())"
+    # The plus '+' symbol indicates string concatenation with newlines.
+    # NOTE: Both lines must use the same quote character: ' or "
+    BUTTON 'Start Collect' "var type=screen.getNamedWidget('COLLECT_TYPE').text();" +
+      "var dur=screen.getNamedWidget('DURATION').text();" +
+      # You can have comments between string concatenations
+      "api.cmd('<%= target_name %> COLLECT with TYPE '+type+', DURATION '+dur)"
   END
   SETTING BACKCOLOR 163 185 163
 
@@ -33,7 +40,9 @@ VERTICAL
       RADIOBUTTON 'Clear'
     END
     NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks' # No option is by default UNCHECKED
-    BUTTON 'Send' "screen.getNamedWidget('GROUP').selected() === 0 ? api.cmd('<%= target_name %> ABORT') : (screen.getNamedWidget('CHECK').checked() ? api.cmd_no_hazardous_check('<%= target_name %> CLEAR') : api.cmd('<%= target_name %> CLEAR'))"
+    BUTTON 'Send' "screen.getNamedWidget('GROUP').selected() === 0 ? " +
+      "api.cmd('<%= target_name %> ABORT') : (screen.getNamedWidget('CHECK').checked() ? " +
+      "api.cmd_no_hazardous_check('<%= target_name %> CLEAR') : api.cmd('<%= target_name %> CLEAR'))"
   END
   SETTING BACKCOLOR 163 185 163
 
@@ -41,7 +50,13 @@ VERTICAL
     SECTIONHEADER "Run Script:"
     NAMED_WIDGET SCRIPTNAME COMBOBOX collect.rb checks.rb
     NAMED_WIDGET BG CHECKBUTTON 'Background'
-    BUTTON 'Run Script' "var script=screen.getNamedWidget('SCRIPTNAME').text(); runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked())"
+    # The backslash '\' character indicates string concatenation without newlines.
+    # NOTE: Both lines must use the same quote character: ' or "
+    BUTTON 'Run Script' "var script=screen.getNamedWidget('SCRIPTNAME').text();" \
+      "var ctype=screen.getNamedWidget('COLLECT_TYPE').text();" \
+      # Set some environment variables to be used by the script as ENV['TYPE']
+      "var env = {}; env['TYPE'] = ctype;" \
+      "runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked(), env)"
   END
   SETTING BACKCOLOR 163 185 163
 END

data/targets/INST/screens/other.txt

@@ -18,5 +18,5 @@ SCROLLWINDOW 200
 
   LABELVALUEDESC INST HEALTH_STATUS TEMP1
   LABELVALUEDESC INST HEALTH_STATUS TEMP1 "Description"
-  TEXTBOX INST ADCS TIMEFORMATTED 400 100
+  TEXTBOX INST ADCS PACKET_TIMEFORMATTED 400 100
 END

data/targets/INST/screens/params.txt

@@ -49,6 +49,6 @@ VERTICAL
   END
 
   VERTICALBOX
-    LABELVALUE <%= target_name %> PARAMS TIMEFORMATTED WITH_UNITS 20
+    LABELVALUE <%= target_name %> PARAMS PACKET_TIMEFORMATTED WITH_UNITS 20
   END
 END

data/targets/INST/screens/tabs.txt

@@ -37,7 +37,7 @@ TABBOOK
     END
 
     VERTICALBOX
-      LABELVALUE <%= target_name %> ADCS TIMEFORMATTED WITH_UNITS 30
+      LABELVALUE <%= target_name %> ADCS PACKET_TIMEFORMATTED WITH_UNITS 30
     END
   END
 
@@ -60,7 +60,7 @@ TABBOOK
     END
 
     VERTICALBOX
-      LABELVALUE <%= target_name %> HEALTH_STATUS TIMEFORMATTED WITH_UNITS 30
+      LABELVALUE <%= target_name %> HEALTH_STATUS PACKET_TIMEFORMATTED WITH_UNITS 30
     END
   END
 END

data/targets/SYSTEM/screens/status.txt

@@ -4,7 +4,6 @@ STALE_TIME 5 # Number of seconds to wait before marking data stale
 VERTICAL
   TITLE "Status"
 
-  LABELVALUE SYSTEM META OPENC3_VERSION
   LABELVALUE INST HEALTH_STATUS COLLECTS
   LABELVALUE INST2 HEALTH_STATUS COLLECTS
   LABELVALUE EXAMPLE STATUS VALUE

data/targets/SYSTEM/target.txt

@@ -1,12 +0,0 @@
-# Ignored Parameters
-IGNORE_PARAMETER PKTID
-IGNORE_PARAMETER CONFIG
-IGNORE_PARAMETER OPENC3_VERSION
-IGNORE_PARAMETER USER_VERSION
-IGNORE_PARAMETER RUBY_VERSION
-
-# Ignored Items
-IGNORE_ITEM PKTID
-IGNORE_ITEM RECEIVED_COUNT
-IGNORE_ITEM RECEIVED_TIMESECONDS
-IGNORE_ITEM RECEIVED_TIMEFORMATTED