openc3-cosmos-fakesat 1.0.2

data/README.md

@@ -0,0 +1,15 @@
+# COSMOS Configuration
+
+See the [OpenC3 COSMOS](https://openc3.com) documentation for all things COSMOS.
+
+## Building the plugin
+
+1. <Path to COSMOS installation>\openc3.bat cli rake build VERSION=X.Y.Z
+   - VERSION is required
+   - gem file will be built locally
+
+## Upload plugin
+
+1. Go to localhost:2900/tools/admin
+1. Click the paperclip icon and choose your plugin.gem file
+1. Click Install on the variables dialog

data/Rakefile

@@ -0,0 +1,21 @@
+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
+  system("gem build #{PLUGIN_NAME}")
+end

data/plugin.txt

@@ -0,0 +1,12 @@
+# Set VARIABLEs here to allow variation in your plugin
+# See https://openc3.com/docs/v5/plugins for more information
+VARIABLE fakesat_target_name FAKESAT
+VARIABLE fakesat_int_name FAKESAT_INT
+
+TARGET FAKESAT <%= fakesat_target_name %>
+  LOG_RETAIN_TIME 360000 # 10 hrs
+  REDUCED_LOG_RETAIN_TIME 360000 # 10hrs
+  TLM_LOG_CYCLE_TIME 300
+
+INTERFACE <%= fakesat_int_name %> simulated_target_interface.rb sim_sat.rb
+  MAP_TARGET <%= fakesat_target_name %>

data/targets/FAKESAT/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/FAKESAT/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/FAKESAT/cmd_tlm/cmds.txt

@@ -0,0 +1,69 @@
+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 %> SET_MODE BIG_ENDIAN "Change spacecraft mode"
+  <%= render "_ccsds_cmd.txt", locals: {id: 4} %>
+  APPEND_PARAMETER MODE 8 UINT 0 2 0 "Desired Mode"
+    REQUIRED
+    STATE SAFE 0
+    STATE CHECKOUT 1
+    STATE OPERATE 2
+
+COMMAND <%= target_name %> SLRPNLDEPLOY BIG_ENDIAN "Deploy solar array panel"
+  <%= render "_ccsds_cmd.txt", locals: {id: 5} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Solar Array Number"
+
+COMMAND <%= target_name %> SLRPNLSTOW BIG_ENDIAN "Stow solar array panel"
+  <%= render "_ccsds_cmd.txt", locals: {id: 6} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Solar Array Number"
+
+COMMAND <%= target_name %> SLRPNLANG BIG_ENDIAN "Set Solar Array Panel Angle"
+  <%= render "_ccsds_cmd.txt", locals: {id: 7} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Solar Array Number"
+  APPEND_PARAMETER ANG 32 FLOAT 0 360 0 "Solar Array Angle"
+    UNITS DEGREES DEG
+
+COMMAND <%= target_name %> TABLE_LOAD BIG_ENDIAN "Load table"
+  <%= render "_ccsds_cmd.txt", locals: {id: 8} %>
+  APPEND_PARAMETER DATA 80 BLOCK "" "Table data"
+
+COMMAND <%= target_name %> HTR_CTRL BIG_ENDIAN "Heater Control ON/OFF"
+  <%= render "_ccsds_cmd.txt", locals: {id: 9} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Heater Number"
+  APPEND_PARAMETER STATE 8 UINT 0 1 0 "Desired State"
+    STATE OFF 0 HAZARDOUS
+    STATE ON 1
+
+COMMAND <%= target_name %> HTR_STATE BIG_ENDIAN "Heater State ON/OFF"
+  <%= render "_ccsds_cmd.txt", locals: {id: 10} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Heater Number"
+  APPEND_PARAMETER STATE 8 UINT 0 1 0 "Desired State"
+    STATE OFF 0
+    STATE ON 1
+
+COMMAND <%= target_name %> HTR_SETPT BIG_ENDIAN "Heater Setpoint"
+  <%= render "_ccsds_cmd.txt", locals: {id: 11} %>
+  APPEND_PARAMETER NUM 8 UINT 1 2 1 "Heater Number"
+  APPEND_PARAMETER SETPT 32 FLOAT -100 100 0 "Setpoint"
+
+COMMAND <%= target_name %> ADCS_CTRL BIG_ENDIAN "ADCS Control of Solar Panel Angle ON/OFF"
+  <%= render "_ccsds_cmd.txt", locals: {id: 12} %>
+  APPEND_PARAMETER STATE 8 UINT 0 1 0 "Desired State"
+    STATE OFF 0 HAZARDOUS
+    STATE ON 1

data/targets/FAKESAT/cmd_tlm/tlm.txt

@@ -0,0 +1,145 @@
+TELEMETRY <%= target_name %> HEALTH_STATUS BIG_ENDIAN "Health and status from the <%= target_name %> target"
+  <%= render "_ccsds_tlm.txt", locals: {apid: 1} %>
+  APPEND_ITEM CMD_ACPT_CNT 32 UINT "Command accept counter"
+  APPEND_ITEM CMD_RJCT_CNT 32 UINT "Command reject counter"
+  APPEND_ITEM MODE 8 UINT "Spacecraft mode"
+    STATE SAFE 0 RED
+    STATE CHECKOUT 1 YELLOW
+    STATE OPERATE 2 GREEN
+  APPEND_ITEM CPU_PWR 32 FLOAT "CPU Power"
+    UNITS WATTS W
+  APPEND_ITEM TABLE_DATA 80 BLOCK "Table Data"
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
+
+TELEMETRY <%= target_name %> THERMAL BIG_ENDIAN "Thermal data"
+  <%= render "_ccsds_tlm.txt", locals: {apid: 2} %>
+  APPEND_ITEM TEMP1 32 FLOAT "Temperature #1"
+    UNITS CELSIUS C
+    FORMAT_STRING "%0.2f"
+    LIMITS DEFAULT 1 ENABLED -10.0 -0.0 40.0 50.0 25.0 35.0
+  APPEND_ITEM TEMP2 32 FLOAT "Temperature #2"
+    UNITS CELSIUS C
+    FORMAT_STRING "%0.2f"
+    LIMITS DEFAULT 1 ENABLED -10.0 -0.0 40.0 50.0 25.0 35.0
+  APPEND_ITEM HEATER1_CTRL 8 UINT "Heater 1 Control ON/OFF"
+    STATE OFF 0
+    STATE ON 1
+  APPEND_ITEM HEATER1_STATE 8 UINT "Heater 1 State ON/OFF"
+    STATE OFF 0
+    STATE ON 1
+  APPEND_ITEM HEATER1_SETPT 32 FLOAT "Heater 1 Setpoint"
+    UNITS CELCIUS C
+  APPEND_ITEM HEATER1_PWR 32 FLOAT "Heater 1 Power"
+    UNITS WATTS W
+  APPEND_ITEM HEATER2_CTRL 8 UINT "Heater 2 Control ON/OFF"
+    STATE OFF 0
+    STATE ON 1
+  APPEND_ITEM HEATER2_STATE 8 UINT "Heater 2 State ON/OFF"
+    STATE OFF 0
+    STATE ON 1
+  APPEND_ITEM HEATER2_SETPT 32 FLOAT "Heater 2 Setpoint"
+    UNITS CELCIUS C
+  APPEND_ITEM HEATER2_PWR 32 FLOAT "Heater 2 Power"
+    UNITS WATTS W
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
+
+TELEMETRY <%= target_name %> ADCS BIG_ENDIAN "Position and attitude data"
+  <%= render "_ccsds_tlm.txt", locals: {apid: 3} %>
+  ITEM POSX             128 32 FLOAT "Position X"
+    UNITS METERS M
+  ITEM POSY             160 32 FLOAT "Position Y"
+    UNITS METERS M
+  ITEM POSZ             192 32 FLOAT "Position Z"
+    UNITS METERS M
+  ITEM VELX             224 32 FLOAT "Velocity X"
+    UNITS METERS_PER_SECOND MPS
+  ITEM VELY             256 32 FLOAT "Velocity Y"
+    UNITS METERS_PER_SECOND MPS
+  ITEM VELZ             288 32 FLOAT "Velocity Z"
+    UNITS METERS_PER_SECOND MPS
+  ITEM Q1               320 32 FLOAT "Quaternion param 1"
+    FORMAT_STRING "%0.6f"
+  ITEM Q2               352 32 FLOAT "Quaternion param 2"
+    FORMAT_STRING "%0.6f"
+  ITEM Q3               384 32 FLOAT "Quaternion param 3"
+    FORMAT_STRING "%0.6f"
+  ITEM Q4               416 32 FLOAT "Quaternion param 4"
+    FORMAT_STRING "%0.6f"
+  ITEM BIASX            448 32 FLOAT "Body X rate bias"
+    FORMAT_STRING "%0.6f"
+  ITEM BIASY            480 32 FLOAT "Body Y rate bias"
+    FORMAT_STRING "%0.6f"
+  ITEM BIASZ            512 32 FLOAT "Body Z rate bias"
+    FORMAT_STRING "%0.6f"
+  <% (1..5).each do |i| %>
+    APPEND_ITEM STAR<%= i %>ID 16 UINT "Star <%= i %> id"
+  <% end %>
+  ITEM POSPROGRESS      624 32 FLOAT "Position file progress"
+    FORMAT_STRING "%0.2f"
+  ITEM ATTPROGRESS      656 32 FLOAT "Attitude file progress"
+    FORMAT_STRING "%0.2f"
+  APPEND_ITEM SR_ANG_TO_SUN 32 FLOAT "Ideal Solar Array Angle to Point at Sun"
+    FORMAT_STRING "%0.2f"
+  APPEND_ITEM ADCS_CTRL 8 UINT "ADCS Control ON/OFF"
+    STATE OFF 0 YELLOW
+    STATE ON 1 GREEN
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
+
+TELEMETRY <%= target_name %> EVENT BIG_ENDIAN "Event packet"
+  <%= render "_ccsds_tlm.txt", locals: {apid: 4} %>
+  APPEND_ITEM MESSAGE 0 STRING "Event Message"
+  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: 5} %>
+  ITEM BYTES 128 32 UINT "First bytes"
+    FORMAT_STRING '0x%08x'
+  ITEM IMAGE 128 0 BLOCK "Image Data"
+    OVERLAP # Notify OpenC3 that this is intentionally overlapping the BYTES field
+  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: 6} %>
+  APPEND_ITEM SLRPNL1_ANG 32 FLOAT    "Solar panel 1 angle"
+    UNITS DEGREES DEG
+  APPEND_ITEM SLRPNL2_ANG 32 FLOAT    "Solar panel 2 angle"
+    UNITS DEGREES DEG
+  APPEND_ITEM SLRPNL1_STATE 8 UINT "Solar panel 1 state DEPLOYED/STOWED"
+    STATE STOWED 0 YELLOW
+    STATE DEPLOYED 1 GREEN
+  APPEND_ITEM SLRPNL2_STATE 8 UINT "Solar panel 2 state DEPLOYED/STOWED"
+    STATE STOWED 0 YELLOW
+    STATE DEPLOYED 1 GREEN
+  APPEND_ITEM SLRPNL1_PWR 32 FLOAT "Solar panel 1 power"
+    LIMITS DEFAULT 1 ENABLED 50 100 505 510
+    UNITS WATTS W
+  APPEND_ITEM SLRPNL2_PWR 32 FLOAT "Solar panel 2 power"
+    LIMITS DEFAULT 1 ENABLED 50 100 505 510
+    UNITS WATTS W
+  APPEND_ITEM BATTERY 32 FLOAT "Battery Percentage"
+    UNITS PERCENT %
+    LIMITS DEFAULT 1 ENABLED 10 50 105 110
+    FORMAT_STRING "%0.2f"
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
+
+TELEMETRY <%= target_name %> IMAGER BIG_ENDIAN "Imager Status"
+  <%= render "_ccsds_tlm.txt", locals: {apid: 7} %>
+  APPEND_ITEM COLLECTS         16 UINT     "Number of collects"
+  APPEND_ITEM DURATION 32 FLOAT "Most recent collect duration"
+  APPEND_ITEM COLLECT_TYPE 16 UINT "Most recent collect type"
+    STATE NORMAL  0
+    STATE SPECIAL 1
+    STATE ERROR ANY
+  APPEND_ITEM IMAGER_STATE 8 UINT "Imager State ON/OFF"
+    STATE OFF 0
+    STATE ON 1
+  APPEND_ITEM IMAGER_PWR 32 FLOAT "Image Power"
+    UNITS WATTS W
+  ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
+    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS

data/targets/FAKESAT/lib/fake_sat.rb

@@ -0,0 +1,6 @@
+class FakeSat
+  # Note use <%= target_name %> if you want to create multiple instances of FakeSat
+
+  def initialize
+  end
+end