cosmos 3.9.2 → 4.0.0

data/demo/config/targets/TEMPLATED/target.txt

@@ -1,3 +1,5 @@
+REQUIRE templated_interface.rb
+
 # Ignored Parameters
 # IGNORE_PARAMETER parameter_name
 IGNORE_PARAMETER CMD_ID

data/demo/config/tools/cmd_tlm_server/cmd_tlm_server.txt

@@ -1,7 +1,15 @@
 TITLE 'COSMOS Command and Telemetry Server - Demo Configuration'
 
-PACKET_LOG_WRITER DEFAULT meta_packet_log_writer.rb META DATA config/data/meta_init.txt
-PACKET_LOG_WRITER COSMOSLOG packet_log_writer.rb cosmos
+# PACKET_LOG_WRITER Parameter Notes
+# nil:use default log names
+# true: logging enabled
+# nil: Don't cycle logs based on time
+# 2000000000: Create new log after 2 Billion bytes
+# nil: Use the default log directory
+# false: Log synchronously - more efficient
+# config/data/meta_init.txt: Initialize SYSTEM META data from this file
+PACKET_LOG_WRITER DEFAULT packet_log_writer.rb nil true nil 2000000000 nil false
+# PACKET_LOG_WRITER SYSTEMLOG packet_log_writer.rb system
 
 # AUTO_INTERFACE_TARGETS # Use cmd_tlm_server.txt from all targets declared in system.txt
 
@@ -15,10 +23,10 @@ INTERFACE_TARGET EXAMPLE cmd_tlm_server.txt # Use cmd_tlm_server.txt in target p
 
 INTERFACE_TARGET TEMPLATED cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
 
-INTERFACE COSMOS_INT cmd_tlm_server_interface.rb
-  TARGET COSMOS
+INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
+  TARGET SYSTEM
   DISABLE_DISCONNECT
-  LOG COSMOSLOG
+  # LOG SYSTEMLOG
   # DONT_LOG
   # DONT_CONNECT
   # DONT_RECONNECT
@@ -36,5 +44,6 @@ ROUTER INST_ROUTER tcpip_server_interface.rb 2055 2055 10.0 nil LENGTH 32 16 7
 
 BACKGROUND_TASK example_background_task.rb
   STOPPED
+BACKGROUND_TASK limits_groups.rb 5 # Initial delay to allow interfaces to connect
 
-#COLLECT_METADATA META DATA
+#COLLECT_METADATA

data/demo/config/tools/cmd_tlm_server/cmd_tlm_server2.txt

@@ -1,7 +1,15 @@
 TITLE 'COSMOS Command and Telemetry Server - Demo Configuration 2'
 
-PACKET_LOG_WRITER DEFAULT meta_packet_log_writer.rb META DATA config/data/meta_init.txt
-PACKET_LOG_WRITER COSMOSLOG packet_log_writer.rb cosmos
+# PACKET_LOG_WRITER Parameter Notes
+# nil:use default log names
+# true: logging enabled
+# nil: Don't cycle logs based on time
+# 2000000000: Create new log after 2 Billion bytes
+# nil: Use the default log directory
+# false: Log synchronously - more efficient
+# config/data/meta_init.txt: Initialize SYSTEM META data from this file
+PACKET_LOG_WRITER DEFAULT packet_log_writer.rb nil true nil 2000000000 nil false
+# PACKET_LOG_WRITER SYSTEMLOG packet_log_writer.rb system
 
 # AUTO_INTERFACE_TARGETS # Use cmd_tlm_server.txt from all targets declared in system.txt
 
@@ -13,10 +21,10 @@ INTERFACE INST2_INT simulated_target_interface.rb sim_inst.rb
 
 INTERFACE_TARGET EXAMPLE cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
 
-INTERFACE COSMOS_INT cmd_tlm_server_interface.rb
-  TARGET COSMOS
+INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
+  TARGET SYSTEM
   DISABLE_DISCONNECT
-  LOG COSMOSLOG
+  # LOG SYSTEMLOG
   # DONT_LOG
   # DONT_CONNECT
   # DONT_RECONNECT

data/demo/config/tools/data_viewer/data_viewer.txt

@@ -9,3 +9,12 @@ COMPONENT "ADCS" data_viewer_component.rb
 COMPONENT "Other Packets" data_viewer_component.rb
   PACKET INST PARAMS
   PACKET INST IMAGE
+
+# Allow DataViewer to automatically detect a config/data_viewer/data_viewer.txt
+# file in each of the target directories and load the configuration
+# AUTO_TARGET_COMPONENTS
+
+# Explicitly load the INST/config/data_viewer/data_viewer.txt file
+TARGET_COMPONENT INST
+# Explicitly load the INST/config/data_viewer/data_viewer2.txt file
+TARGET_COMPONENT INST data_viewer2.txt

data/demo/config/tools/launcher/launcher.txt

@@ -6,6 +6,13 @@ NUM_COLUMNS 5 # This is the default
 TOOL "Command and Telemetry Server" "LAUNCH CmdTlmServer" "cts.png" --config cmd_tlm_server.txt
 TOOL "Replay" "LAUNCH Replay" "replay.png"
 TOOL "Limits Monitor" "LAUNCH LimitsMonitor" "limits_monitor.png"
+MULTITOOL_START "Simulated Targets" NULL
+  TOOL "LAUNCH_TERMINAL ExampleTarget"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
+  TOOL "LAUNCH_TERMINAL ScpiTarget"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
+MULTITOOL_END
+# Example of another multitool button
 MULTITOOL_START "COSMOS"
   TOOL "LAUNCH CmdTlmServer -x 827 -y 2 -w 756 -t 475 -c cmd_tlm_server.txt"
   DELAY 5
@@ -19,14 +26,9 @@ DIVIDER
 LABEL "Commanding and Scripting"
 
 TOOL "Command Sender" "LAUNCH CmdSender" "cmd_sender.png"
+TOOL "Command Sequence" "LAUNCH CmdSequence" "cmd_sequence.png"
 TOOL "Script Runner" "LAUNCH ScriptRunner" "script_runner.png"
 TOOL "Test Runner" "LAUNCH TestRunner" "test_runner.png"
-MULTITOOL_START "Simulated Targets" NULL
-  TOOL "LAUNCH_TERMINAL ExampleTarget"
-    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
-  TOOL "LAUNCH_TERMINAL ScpiTarget"
-    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
-MULTITOOL_END
 
 DIVIDER
 LABEL Telemetry
@@ -39,6 +41,7 @@ TOOL "Data Viewer" "LAUNCH DataViewer" "data_viewer.png"
 DIVIDER
 LABEL Utilities
 
+TOOL "Config Editor" "LAUNCH ConfigEditor" "config_editor.png"
 TOOL "Telemetry Extractor" "LAUNCH TlmExtractor" "tlm_extractor.png"
 TOOL "Command Extractor" "LAUNCH CmdExtractor" "cmd_extractor.png"
 TOOL "Handbook Creator" "LAUNCH HandbookCreator" "handbook_creator.png"

data/demo/config/tools/launcher/launcher2.txt

@@ -6,27 +6,30 @@ LABEL_FONT tahoma 16
 TOOL "Command and Telemetry Server" "LAUNCH CmdTlmServer --system system2.txt" "cts.png" --config cmd_tlm_server2.txt
 TOOL "Replay" "LAUNCH Replay --system system2.txt" "replay.png"
 TOOL "Limits Monitor" "LAUNCH LimitsMonitor --system system2.txt" "limits_monitor.png"
-MULTITOOL_START "COSMOS" NULL
-  TOOL "LAUNCH CmdTlmServer -x 827 -y 2 -w 756 -t 475 -c cmd_tlm_server2.txt --system system2.txt"
-  DELAY 5
-  TOOL "LAUNCH TlmViewer -x 827 -y 517 -w 424 -t 111 --system system2.txt"
-  TOOL "LAUNCH PacketViewer -x 827 -y 669 -w 422 -t 450 --system system2.txt"
-  TOOL "LAUNCH ScriptRunner -x 4 -y 2 -w 805 -t 545 --system system2.txt"
-  TOOL "LAUNCH CmdSender -x 4 -y 586 -w 805 -t 533 --system system2.txt"
+MULTITOOL_START "Simulated Targets" NULL
+  TOOL "tools\ExampleTarget.bat"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
+  TOOL "tools\ScpiTarget.bat"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
 MULTITOOL_END
 
+# Example of using a multitool button
+#MULTITOOL_START "COSMOS" NULL
+#  TOOL "LAUNCH CmdTlmServer -x 827 -y 2 -w 756 -t 475 -c cmd_tlm_server2.txt --system system2.txt"
+#  DELAY 5
+#  TOOL "LAUNCH TlmViewer -x 827 -y 517 -w 424 -t 111 --system system2.txt"
+#  TOOL "LAUNCH PacketViewer -x 827 -y 669 -w 422 -t 450 --system system2.txt"
+#  TOOL "LAUNCH ScriptRunner -x 4 -y 2 -w 805 -t 545 --system system2.txt"
+#  TOOL "LAUNCH CmdSender -x 4 -y 586 -w 805 -t 533 --system system2.txt"
+#MULTITOOL_END
+
 DIVIDER
 LABEL "Commanding and Scripting"
 
 TOOL "Command Sender" "LAUNCH CmdSender --system system2.txt" "cmd_sender.png"
+TOOL "Command Sequence" "LAUNCH CmdSequence --system system2.txt" "cmd_sequence.png"
 TOOL "Script Runner" "LAUNCH ScriptRunner --system system2.txt" "script_runner.png"
 TOOL "Test Runner" "LAUNCH TestRunner --system system2.txt" "test_runner.png"
-MULTITOOL_START "Simulated Targets" NULL
-  TOOL "tools\ExampleTarget.bat"
-    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
-  TOOL "tools\ScpiTarget.bat"
-    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
-MULTITOOL_END
 
 DIVIDER
 LABEL Telemetry

data/demo/config/tools/launcher/launcher_mini.txt

@@ -0,0 +1,45 @@
+TITLE "Launcher"
+TOOL_FONT tahoma 12
+LABEL_FONT tahoma 16
+NUM_COLUMNS 2
+
+TOOL "Server" "LAUNCH CmdTlmServer" "cts.png" --config cmd_tlm_server.txt
+TOOL "Replay" "LAUNCH Replay" "replay.png"
+TOOL "Limits" "LAUNCH LimitsMonitor" "limits_monitor.png"
+MULTITOOL_START "Targets" NULL
+  TOOL "LAUNCH_TERMINAL ExampleTarget"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
+  TOOL "LAUNCH_TERMINAL ScpiTarget"
+    DONT_CAPTURE_IO # Without this you get an "Unexpected Output" dialog
+MULTITOOL_END
+# Example of a multitool button
+#MULTITOOL_START "COSMOS"
+#  TOOL "LAUNCH CmdTlmServer -x 827 -y 2 -w 756 -t 475 -c cmd_tlm_server.txt"
+#  DELAY 5
+#  TOOL "LAUNCH TlmViewer -x 827 -y 517 -w 424 -t 111"
+#  TOOL "LAUNCH PacketViewer -x 827 -y 669 -w 422 -t 450"
+#  TOOL "LAUNCH ScriptRunner -x 4 -y 2 -w 805 -t 545"
+#  TOOL "LAUNCH CmdSender -x 4 -y 586 -w 805 -t 533"
+#MULTITOOL_END
+
+DIVIDER
+
+TOOL "CmdSender" "LAUNCH CmdSender" "cmd_sender.png"
+TOOL "CmdSequence" "LAUNCH CmdSequence" "cmd_sequence.png"
+TOOL "ScriptRunner" "LAUNCH ScriptRunner" "script_runner.png"
+TOOL "TestRunner" "LAUNCH TestRunner" "test_runner.png"
+
+DIVIDER
+
+TOOL "PktViewer" "LAUNCH PacketViewer" "packet_viewer.png"
+TOOL "TlmViewer" "LAUNCH TlmViewer" "tlm_viewer.png"
+TOOL "TlmGrapher" "LAUNCH TlmGrapher" "tlm_grapher.png"
+TOOL "DataViewer" "LAUNCH DataViewer" "data_viewer.png"
+
+DIVIDER
+
+TOOL "ConfigEditor" "LAUNCH ConfigEditor" "config_editor.png"
+TOOL "TlmExtractor" "LAUNCH TlmExtractor" "tlm_extractor.png"
+TOOL "Handbooks" "LAUNCH HandbookCreator" "handbook_creator.png"
+TOOL "CmdExtractor" "LAUNCH CmdExtractor" "cmd_extractor.png"
+TOOL "TblManager" "LAUNCH TableManager" "table_manager.png"

data/demo/config/tools/table_manager/MCConfigurationTable_fsw1_def.txt

@@ -19,18 +19,19 @@ TABLE "MC Configuration" BIG_ENDIAN ONE_DIMENSIONAL "Memory Control Configuratio
   APPEND_PARAMETER "Scrub Region 2 Throttle Ticks" 32 UINT 0 0x0FFFFFFFF 2
   APPEND_PARAMETER "Dump Packet Throttle (sec)" 32 UINT 0 0x0FFFFFFFF 2 "Number of seconds to wait between dumping large packets"
   APPEND_PARAMETER "Memory Scrubbing" 8 UINT 0 1 1
-    STATE DISABLE 0 
-    STATE ENABLE 1 
+    STATE DISABLE 0
+    STATE ENABLE 1
   APPEND_PARAMETER "SIOC Memory Config" 8 UINT 1 3 3
-    #CONSTRAINT_START
-    #  if packet.read("Memory Scrubbing") == 'DISABLE'
-    #    packet.get_item("SIOC Memory Config").range = (10..20)
-    #  else
-    #    packet.get_item("SIOC Memory Config").range = (1..3)
-    #  end
-    #CONSTRAINT_END
-  APPEND_PARAMETER "Pad" 16 UINT 0 0 0 
+    GENERIC_WRITE_CONVERSION_START
+      if packet.read("Memory Scrubbing") == 'DISABLE'
+        packet.get_item("SIOC Memory Config").range = (10..20)
+      else
+        packet.get_item("SIOC Memory Config").range = (1..3)
+      end
+      value
+    GENERIC_WRITE_CONVERSION_END
+  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"
+  APPEND_PARAMETER "Pad" 16 UINT 0 0 0
     HIDDEN
   APPEND_PARAMETER "Pad1" 32 UINT MIN MAX 0xFFFFFFFF
     HIDDEN
-

data/demo/config/tools/table_manager/MCConfigurationTable_fsw2_def.txt

@@ -19,15 +19,16 @@ TABLE "MC Configuration" BIG_ENDIAN ONE_DIMENSIONAL "Memory Control Configuratio
   APPEND_PARAMETER "Scrub Region 2 Throttle Ticks" 32 UINT 0 0x0FFFFFFFF 2
   APPEND_PARAMETER "Dump Packet Throttle (sec)" 32 UINT 0 0x0FFFFFFFF 2 "Number of seconds to wait between dumping large packets"
   APPEND_PARAMETER "Memory Scrubbing" 8 UINT 0 1 1
-    STATE DISABLE 0 
-    STATE ENABLE 1 
+    STATE DISABLE 0
+    STATE ENABLE 1
   APPEND_PARAMETER "SIOC Memory Config" 8 UINT 1 3 3
-    #CONSTRAINT_START
-    #  if packet.read("Memory Scrubbing") == 'DISABLE'
-    #    packet.get_item("SIOC Memory Config").range = (10..20)
-    #  else
-    #    packet.get_item("SIOC Memory Config").range = (1..3)
-    #  end
-    #CONSTRAINT_END
-  APPEND_PARAMETER "Pad" 16 UINT 0 0 0 
-
+    GENERIC_WRITE_CONVERSION_START
+      if packet.read("Memory Scrubbing") == 'DISABLE'
+        packet.get_item("SIOC Memory Config").range = (10..20)
+      else
+        packet.get_item("SIOC Memory Config").range = (1..3)
+      end
+      value
+    GENERIC_WRITE_CONVERSION_END
+  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"
+  APPEND_PARAMETER "Pad" 16 UINT 0 0 0

data/demo/config/tools/test_runner/test_runner.txt

@@ -10,7 +10,7 @@ LOOP_TESTING FALSE
 BREAK_LOOP_AFTER_ERROR FALSE
 CREATE_DATA_PACKAGE
 AUTO_CYCLE_LOGS
-COLLECT_METADATA META DATA
+COLLECT_METADATA
 # IGNORE_TEST_SUITE EmptyTestSuite
 # IGNORE_TEST EmptyTest
 # MONITOR_LIMITS

data/demo/config/tools/tlm_viewer/tlm_viewer.txt

@@ -3,15 +3,15 @@ AUTO_TARGETS
 
 # Create a new dropdown with a few specific sceens
 GROUP "My group"
-  GROUP_SCREEN "COSMOS" "version.txt"
-  GROUP_SCREEN "INST" "hs.txt"
-  GROUP_SCREEN "INST2" "hs.txt"
+  GROUP_SCREEN SYSTEM "status.txt"
+  GROUP_SCREEN INST "hs.txt"
+  GROUP_SCREEN INST2 "hs.txt"
 
 # NEW_COLUMN
 
 # AUTO_TARGET INST
 
-# TARGET "INST"
+# TARGET INST
 #  SCREEN "adcs.txt"
 #  SCREEN "array.txt"
 #  SCREEN "block.txt"
@@ -24,7 +24,7 @@ GROUP "My group"
 #  SCREEN "other.txt"
 #  SCREEN "tabs.txt"
 
-#TARGET "INST2"
+#TARGET INST2
 #  SCREEN "adcs.txt"
 #  SCREEN "array.txt"
 #  SCREEN "block.txt"

data/demo/lib/example_background_task.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2017 Ball Aerospace & Technologies Corp.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -25,13 +25,17 @@ module Cosmos
       @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
-        if (tlm('INST', 'HEALTH_STATUS', 'COLLECTS') < 3)
+        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.formatted}"
+            @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
@@ -40,12 +44,12 @@ module Cosmos
         end
         return if @sleeper.sleep(1)
       end
-      @status = "Finished at #{Time.now.formatted}"
+      @status = "Finished at #{Time.now.sys.formatted}"
     end
 
     def stop
       @sleeper.cancel
-      @status = "Stopped at #{Time.now.formatted}"
+      @status = "Stopped at #{Time.now.sys.formatted}"
     end
   end
 end

data/demo/lib/example_target.rb

@@ -13,25 +13,17 @@ require 'cosmos/interfaces'
 require 'cosmos/tools/cmd_tlm_server/interface_thread'
 
 module Cosmos
-
   class ExampleTarget
-
     class ExampleServerInterface < TcpipServerInterface
       PORT = 9999
 
       def initialize
-        super(PORT, PORT, 5.0, nil, 'LENGTH', 0, 32, 4, 1, 'BIG_ENDIAN', 4)
-      end
-
-      def pre_write_packet(packet)
-        [packet.length].pack('N') << packet.buffer(false)
+        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
@@ -55,9 +47,9 @@ module Cosmos
         @thread = Thread.new do
           @stop_thread = false
           begin
-            while true
+            loop do
               packet.write('PACKET_ID', 1)
-              packet.write('STRING', "The time is now: #{Time.now.formatted}")
+              packet.write('STRING', "The time is now: #{Time.now.sys.formatted}")
               @interface.write(packet)
               break if @sleeper.sleep(1)
             end
@@ -107,7 +99,5 @@ module Cosmos
         target.stop
       end
     end
-
-  end # class ExampleTarget
-
-end # module Cosmos
+  end
+end

data/demo/lib/scpi_target.rb

@@ -13,9 +13,7 @@ require 'cosmos/interfaces'
 require 'cosmos/tools/cmd_tlm_server/interface_thread'
 
 module Cosmos
-
   class ScpiTarget
-
     class ScpiServerInterface < TcpipServerInterface
       PORT = 5025
 
@@ -35,7 +33,7 @@ module Cosmos
       def handle_packet(packet)
         Logger.info "Received command: #{packet.buffer}"
         if packet.buffer.include?('?')
-          @interface.write_raw(@index.to_s)
+          @interface.write_raw(@index.to_s + "\x0A")
         end
         @index += 1
       end
@@ -61,14 +59,10 @@ module Cosmos
       target = self.new
       begin
         target.start
-        while true
-          sleep 1
-        end
+        loop { sleep 1 }
       rescue SystemExit, Interrupt
         target.stop
       end
     end
-
-  end # class ScpiTarget
-
-end # module Cosmos
+  end
+end