openc3-cosmos-fakesat 1.0.2

data/targets/FAKESAT/procedures/set_override_inject_tlm.rb

@@ -0,0 +1,41 @@
+cmd("FAKESAT SET_MODE with MODE SAFE")
+wait_check("FAKESAT HEALTH_STATUS MODE == 'SAFE'", 5)
+
+prompt("Ensure Packet Viewer is open to INST HEALTH_STATUS and watch MODE")
+
+# Call set_tlm twice to ensure it gets processed as real tlm flows
+set_tlm("FAKESAT HEALTH_STATUS MODE = 'OPERATE'")
+wait 0.2
+set_tlm("FAKESAT HEALTH_STATUS MODE = 'OPERATE'")
+wait 5 # Should see PacketViewer briefly
+# This check fails as we receive data and revert back to 'SAFE'
+check("FAKESAT HEALTH_STATUS MODE == 'OPERATE'")
+# set_tlm back to SAFE to restore in the disconnected version
+set_tlm("FAKESAT HEALTH_STATUS MODE = 'SAFE'")
+set_tlm("FAKESAT HEALTH_STATUS MODE = 0", type: :RAW)
+
+override_tlm("FAKESAT HEALTH_STATUS MODE = 'OPERATE'")
+wait 2
+# By default it overrides all the value types with the value
+# This includes types that might not make sense like :RAW
+check("FAKESAT HEALTH_STATUS MODE == 'OPERATE'", type: :RAW)
+check("FAKESAT HEALTH_STATUS MODE == 'OPERATE'", type: :CONVERTED)
+check("FAKESAT HEALTH_STATUS MODE == 'OPERATE'", type: :FORMATTED)
+check("FAKESAT HEALTH_STATUS MODE == 'OPERATE'", type: :WITH_UNITS)
+wait
+# Clear the overrides
+normalize_tlm("FAKESAT HEALTH_STATUS MODE")
+wait_check("FAKESAT HEALTH_STATUS MODE == 0", 5, type: :RAW)
+wait_check("FAKESAT HEALTH_STATUS MODE == 'SAFE'", 5) # default CONVERTED
+wait_check("FAKESAT HEALTH_STATUS MODE == 'SAFE'", 5, type: :FORMATTED)
+wait_check("FAKESAT HEALTH_STATUS MODE == 'SAFE'", 5, type: :WITH_UNITS)
+wait
+
+# Packet Viewer shows all telemetry zeroed except MODE
+# Call inject_tlm twice to ensure it gets processed as real tlm flows
+inject_tlm("FAKESAT", "HEALTH_STATUS", { "MODE" => "OPERATE" })
+wait 0.2
+inject_tlm("FAKESAT", "HEALTH_STATUS", { "MODE" => "OPERATE" })
+wait 2
+# With flowing tlm, the next received packet overwrites so we're back
+wait_check("FAKESAT HEALTH_STATUS MODE == 'SAFE'", 2)

data/targets/FAKESAT/screens/status.txt

@@ -0,0 +1,24 @@
+SCREEN AUTO AUTO 1.0
+
+HORIZONTAL
+  VERTICALBOX ADCS
+    LABELVALUE FAKESAT ADCS Q1
+    LABELVALUE FAKESAT ADCS Q2
+    LABELVALUE FAKESAT ADCS Q3
+    LABELVALUE FAKESAT ADCS Q4
+  END
+  VERTICAL
+    VERTICALBOX Health Status
+      LABELVALUE FAKESAT HEALTH_STATUS CMD_ACPT_CNT
+      LABELVALUE FAKESAT HEALTH_STATUS MODE
+      LABELVALUE FAKESAT IMAGER COLLECTS
+    END
+  END
+END
+VERTICALBOX Mech
+  LABELVALUE FAKESAT MECH SLRPNL1_ANG
+  LABELVALUE FAKESAT MECH SLRPNL2_ANG
+END
+VERTICALBOX Event
+  LABELVALUE FAKESAT EVENT MESSAGE CONVERTED 50
+END

data/targets/FAKESAT/tables/config/ConfigTables_def.txt

@@ -0,0 +1,7 @@
+# This file references table definitions contained in stand alone
+# files. The syntax is:
+#   TABLEFILE "FileName_def.txt"
+
+TABLEFILE "MCConfigurationTable_def.txt"
+TABLEFILE "TLMMonitoringTable_def.txt"
+TABLEFILE "PPSSelectionTable_def.txt"

data/targets/FAKESAT/tables/config/MCConfigurationTable_def.txt

@@ -0,0 +1,36 @@
+TABLE "MC_Configuration" BIG_ENDIAN KEY_VALUE "Memory Control Configuration Table"
+  APPEND_PARAMETER "Scrub_Region_1_Start_Addr" 32 UINT 0 0x03FFFFFB 0
+    FORMAT_STRING "0x%0X"
+  APPEND_PARAMETER "Scrub_Region_1_End_Addr" 32 UINT 0 0x03FFFFFF 0x03FFFFFF
+    FORMAT_STRING "0x%0X"
+  APPEND_PARAMETER "Scrub_Region_2_Start_Addr" 32 UINT 0 0x03FFFFB 0
+    FORMAT_STRING "0x%0X"
+  APPEND_PARAMETER "Scrub_Region_2_End_Addr" 32 UINT 0 0x03FFFFF 0x03FFFFF
+    FORMAT_STRING "0x%0X"
+  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
+  APPEND_PARAMETER "SIOC_Memory_Config" 8 UINT 1 3 3
+    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 "Uneditable_Text" 32 UINT MIN MAX 0xDEADBEEF "Uneditable field"
+    FORMAT_STRING "0x%0X"
+    UNEDITABLE
+  APPEND_PARAMETER "Uneditable_State" 16 UINT MIN MAX 0 "Uneditable field"
+    STATE DISABLE 0
+    STATE ENABLE 1
+    UNEDITABLE
+  APPEND_PARAMETER "Uneditable_Check" 16 UINT MIN MAX 1 "Uneditable field"
+    STATE UNCHECKED 0
+    STATE CHECKED 1
+    UNEDITABLE
+  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"
+  APPEND_PARAMETER "Pad" 16 UINT 0 0 0
+    HIDDEN

data/targets/FAKESAT/tables/config/PPSSelectionTable_def.txt

@@ -0,0 +1,7 @@
+TABLE "PPS_Selection" BIG_ENDIAN KEY_VALUE "Payload Clock Control Pulse Per Second Selection Table"
+  APPEND_PARAMETER "Primary_PPS" 8 UINT 0 1 1
+    STATE CHECKED 1
+    STATE UNCHECKED 0
+  APPEND_PARAMETER "Redundant_PPS" 8 UINT 0 1 0
+    STATE UNCHECKED 0
+    STATE CHECKED 1

data/targets/FAKESAT/tables/config/TLMMonitoringTable_def.txt

@@ -0,0 +1,31 @@
+TABLE "TLM_Monitoring" BIG_ENDIAN ROW_COLUMN 100 "Telemetry Monitoring Table"
+  APPEND_PARAMETER "Threshold" 32 UINT MIN MAX 0 "Telemetry item threshold at which point persistance is incremented"
+  APPEND_PARAMETER "Offset" 32 UINT MIN MAX 0 "Offset into the telemetry packet to monitor"
+  APPEND_PARAMETER "Data_Size" 32 UINT 0 3 0 "Amount of data to monitor (bytes)"
+    STATE BITS 0
+    STATE BYTE 1
+    STATE WORD 2
+    STATE LONGWORD 3
+  APPEND_PARAMETER "Bit_Mask" 32 UINT MIN MAX 0 "Bit Mask to apply to the Data Size before the value is compared ot the Threshold"
+  APPEND_PARAMETER "Persistence" 32 UINT MIN MAX 0 "Number of times the Threshold must be exceeded before Action is triggered"
+  APPEND_PARAMETER "Type" 32 UINT 0 3 0 "How the Threshold is compared against"
+    STATE LESS_THAN 0
+    STATE GREATER_THAN 1
+    STATE EQUAL_TO 2
+    STATE NOT_EQUAL_TO 3
+  APPEND_PARAMETER "Action" 32 UINT 0 4 0 "Action to take when Persistance is met"
+    STATE NO_ACTION_REQUIRED 0
+    STATE INITIATE_RESET 1
+    STATE CHANGE_MODE_SAFE 2
+  APPEND_PARAMETER "Group" 32 UINT 1 4 1 "Telemetry group this monitor item belongs to. Groups are automatically enabled due to payload events."
+    STATE ALL_MODES 1
+    STATE SAFE_MODE 2
+  APPEND_PARAMETER "Signed" 8 UINT 0 2 0 "Whether to treat the Data Size data as signed or unsigned when comparing to the Threshold"
+    STATE NOT_APPLICABLE 0
+    STATE UNSIGNED 1
+    STATE SIGNED 2
+
+# Note we're creating 100 DEFAULT rows to match our 100 row table
+<% 100.times do %>
+DEFAULT 0x0 0 BITS 0x0 0 LESS_THAN NO_ACTION_REQUIRED ALL_MODES UNSIGNED
+<% end %>

data/targets/FAKESAT/tables/procedures/download.rb

@@ -0,0 +1,16 @@
+# TBL_FILENAME is set to the name of the table file to overwrite
+puts "file:#{ENV['TBL_FILENAME']}"
+# Download the file
+# Implement custom commanding logic to download the table
+# You probably want to do something like:
+buffer = ''
+# i = 1
+# num_segments = 5 # calculate based on TBL_FILENAME
+# table_id = 1  # calculate based on TBL_FILENAME
+# while i < num_segments
+#   # Request a part of the table buffer
+#   cmd("TGT DUMP with TABLE_ID #{table_id}, SEGMENT #{i}")
+#   buffer += tlm("TGT DUMP_PKT DATA")
+#   i += 1
+# end
+put_target_file(ENV['TBL_FILENAME'], buffer)

data/targets/FAKESAT/tables/procedures/upload.rb

@@ -0,0 +1,19 @@
+# TBL_FILENAME is set to the name of the table file
+puts "file:#{ENV['TBL_FILENAME']}"
+# Open the file
+file = get_target_file(ENV['TBL_FILENAME'])
+buffer = file.read
+# puts buffer.formatted
+# Implement custom commanding logic to upload the table
+# Note that buffer is a Ruby string of bytes
+# You probably want to do something like:
+# buf_size = 512 # Size of a buffer in the upload command
+# i = 0
+# while i < buffer.length
+#   # Send a part of the buffer
+#   # NOTE: triple dots means start index, up to but not including, end index
+#   #   while double dots means start index, up to AND including, end index
+#   cmd("TGT", "UPLOAD", "DATA" => buffer[i...(i + buf_size)])
+#   i += buf_size
+# end
+file.delete

data/targets/FAKESAT/target.txt

@@ -0,0 +1,32 @@
+REQUIRE sim_sat.rb
+
+# Ignored Parameters
+IGNORE_PARAMETER CCSDSVER
+IGNORE_PARAMETER CCSDSTYPE
+IGNORE_PARAMETER CCSDSSHF
+IGNORE_PARAMETER CCSDSAPID
+IGNORE_PARAMETER CCSDSSEQFLAGS
+IGNORE_PARAMETER CCSDSSEQCNT
+IGNORE_PARAMETER CCSDSLENGTH
+IGNORE_PARAMETER PKTID
+
+# Ignored Items
+IGNORE_ITEM CCSDSVER
+IGNORE_ITEM CCSDSTYPE
+IGNORE_ITEM CCSDSSHF
+IGNORE_ITEM CCSDSAPID
+IGNORE_ITEM CCSDSSEQFLAGS
+IGNORE_ITEM CCSDSSEQCNT
+IGNORE_ITEM CCSDSLENGTH
+IGNORE_ITEM PACKET_TIME
+IGNORE_ITEM PACKET_TIMESECONDS
+IGNORE_ITEM RECEIVED_TIMESECONDS
+IGNORE_ITEM TIMESEC
+IGNORE_ITEM TIMEUS
+IGNORE_ITEM PKTID
+
+# Explicitly define command and telemetry files
+# If not given then all the files in cmd/tlm will be processed in
+# alphabetical order
+COMMANDS cmds.txt
+TELEMETRY tlm.txt

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: openc3-cosmos-fakesat
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Ryan Melton
+- Jason Thomas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-09 00:00:00.000000000 Z
+dependencies: []
+description: "    cosmos-fakesat plugin facilitating COSMOS user training\n"
+email:
+- ryan@openc3.com
+- jason@openc3.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- plugin.txt
+- targets/FAKESAT/cmd_tlm/_ccsds_cmd.txt
+- targets/FAKESAT/cmd_tlm/_ccsds_tlm.txt
+- targets/FAKESAT/cmd_tlm/cmds.txt
+- targets/FAKESAT/cmd_tlm/tlm.txt
+- targets/FAKESAT/data/attitude.bin
+- targets/FAKESAT/data/position.bin
+- targets/FAKESAT/lib/fake_sat.rb
+- targets/FAKESAT/lib/sim_sat.rb
+- targets/FAKESAT/procedures/fix_fakesat.rb
+- targets/FAKESAT/procedures/mem_load.rb
+- targets/FAKESAT/procedures/ops_suite.rb
+- targets/FAKESAT/procedures/set_override_inject_tlm.rb
+- targets/FAKESAT/screens/status.txt
+- targets/FAKESAT/tables/bin/ConfigTables.bin
+- targets/FAKESAT/tables/config/ConfigTables_def.txt
+- targets/FAKESAT/tables/config/MCConfigurationTable_def.txt
+- targets/FAKESAT/tables/config/PPSSelectionTable_def.txt
+- targets/FAKESAT/tables/config/TLMMonitoringTable_def.txt
+- targets/FAKESAT/tables/procedures/download.rb
+- targets/FAKESAT/tables/procedures/upload.rb
+- targets/FAKESAT/target.txt
+homepage: https://github.com/OpenC3/cosmos
+licenses:
+- AGPL-3.0-only
+- Nonstandard
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: OpenC3 cosmos-fakesat plugin
+test_files: []