openc3-cosmos-demo 5.9.0 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af9f49c37fcf900282ef8bc096af738550524a795ff79fdbf23df8e406aa6b6
-  data.tar.gz: 1147b60e93df32fb5a02a369e182dbf863423f3d99dc26a292c86c32d97638e9
+  metadata.gz: 49c8b08aed9217cc75cef91c81f6016e0be0e05e996c63c82a31fb831750501d
+  data.tar.gz: 1a1dd25d45312617988d05daa6b406b018c653544978bc23aeec28d47f30da5f
 SHA512:
-  metadata.gz: dfd96514bf61d59e277ad3a50ccf5aca23121c77967cea7332f42f737ed04c006fc839c429d837a62ab97e809eac8a4763d4030db49a0a9a6dcd888a108ef72d
-  data.tar.gz: be13b794e425aaa13d49dc7e73010ceea90a2be535615a730aa1d732cf0b4ad04a85ecc6af48a7a58e5fb6f2a3f25be292eea4f37d56b79fddbeeaba4f72d93e
+  metadata.gz: cf3da9e0a8071ffccc69da8b2f0a387c741669f29e240648fc357d4f3aaaf17d2b325f57811e7ad6892c03410c30910a570aaab46b453131b68b38c7a0375df6
+  data.tar.gz: 91ebb120aa9a014780fc4399457ce72f87c0ffdca0fb4d7f3bf7764f7d2f6ccd490c942b56920ce09fae62264e98b4643f1b3f0023904db4daa3a7f34f3fc730

data/targets/INST/procedures_py/checks.py

@@ -0,0 +1,17 @@
+import os
+from openc3.script import *
+
+# Display the environment variables
+print(os.environ.items())
+
+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")
+cmd_no_hazardous_check("<%= target_name %> COLLECT with DURATION 11, TYPE NORMAL")
+cmd_no_checks("<%= target_name %> COLLECT with DURATION 11, TYPE NORMAL")
+wait_check(f"<%= target_name %> HEALTH_STATUS COLLECTS == {collect_cnt + 2}", 10)
+cmd("<%= target_name %> CLEAR")
+cmd_no_range_check("<%= target_name %> CLEAR")
+cmd_no_hazardous_check("<%= target_name %> CLEAR")
+cmd_no_checks("<%= target_name %> CLEAR")
+print(tlm("<%= target_name %> HEALTH_STATUS COLLECTS"))

data/targets/INST/procedures_py/collect.py

@@ -0,0 +1,21 @@
+from openc3.script import *
+
+load_utility("<%= target_name %>/procedures_py/utilities/collect.py")
+load_utility("<%= target_name %>/procedures_py/utilities/clear.py")
+
+number = ask("Enter a number.")
+if not isinstance(number, (int, float)):
+    raise RuntimeError("Bad return")
+number = ask_string("Enter a number.")
+if not type(number) == str:
+    raise RuntimeError("Bad return")
+
+result = message_box("Click something.", "CHOICE1", "CHOICE2")
+
+prompt("Press Ok to start NORMAL Collect")
+collect("NORMAL", 1)
+prompt("Press Ok to start SPECIAL Collect")
+collect("SPECIAL", 2, True)
+clear()
+
+wait_check("<%= target_name %> HEALTH_STATUS COLLECTS == 0", 10)

data/targets/INST/procedures_py/disconnect.py

@@ -0,0 +1,23 @@
+from openc3.script import *
+
+cmd("<%= target_name %> ABORT")
+cmd_no_range_check("<%= target_name %> COLLECT with TYPE NORMAL, TEMP 100")
+cmd_no_hazardous_check("<%= target_name %> CLEAR")
+cmd_no_checks("<%= target_name %> COLLECT with TYPE SPECIAL, TEMP 100.0")
+cmd_raw("<%= target_name %> ABORT")
+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_tolerance("<%= target_name %> ADCS BIASX", 5, 0.5)
+check_expression("True == False")
+wait()
+wait(5)
+wait("<%= target_name %> ADCS BIASX > 100", 5)
+wait_tolerance("<%= 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_tolerance("<%= target_name %> ADCS BIASX", 5, 0.5, 5)
+wait_check_expression("True == False", 5)
+wait_check_packet("<%= target_name %>", "ADCS", 2, 5)

data/targets/INST/procedures_py/file_dialog.py

@@ -0,0 +1,18 @@
+from openc3.script import *
+
+# Specify the title and message and filter to txt files
+file = open_file_dialog(
+    "Open a single file", "Choose something interesting", filter=".txt"
+)
+print(file)  # Python File object
+print(file.path)  # Path of the tempfile (generally not used)
+print(file.filename)  # Filename that was selected in the dialog
+print(file.read)
+file.delete
+
+files = open_files_dialog("Open multiple files")  # message is optional
+print(files)  # Array of File objects (even if you select only one)
+for file in files:
+    print(file.filename)
+    print(file.read)
+    file.delete

data/targets/INST/procedures_py/metadata.py

@@ -0,0 +1,25 @@
+from openc3.script import *
+
+# 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.
+print(metadata_get())
+print(metadata_set({"setkey": 1}))
+check_expression(f"{len(metadata_all())} >= 1")
+check_expression(f"{metadata_get()['metadata']} == {{'setkey':1}}")
+print(metadata_get()["metadata"])
+print(metadata_update({"setkey": 2, "updatekey": 3}))
+check_expression(f"{metadata_get()['metadata']['setkey']} == 2")
+check_expression(f"{metadata_get()['metadata']['updatekey']} == 3")
+print(metadata_update({"setkey": 4}))  # Ensure updatekey stays
+check_expression(f"{metadata_get()['metadata']['setkey']} == 4")
+check_expression(f"{metadata_get()['metadata']['updatekey']} == 3")
+check_expression(f"{len(metadata_all())} >= 1")
+# TODO: metadata_input()  # Creates a new entry
+metadata_set({"input": 5})  # Simulate metadat_input for now
+check_expression(f"{len(metadata_all())} >= 2")
+wait(2)  # Allow time to advance or it's an error
+metadata_set({"new": 5})  # Another new entry
+check_expression(f"{len(metadata_all())} >= 3")
+# The first entry is the newest one we created
+print(metadata_all)
+check_expression(f"{metadata_all()[0]['metadata']} == {{'new':5}}")

data/targets/INST/procedures_py/screens.py

@@ -0,0 +1,35 @@
+from openc3.script import *
+
+all_screens = get_screen_list()
+print(all_screens["INST"])
+wait(1)
+definition = get_screen_definition("INST", "ADCS")
+print(definition)
+wait(1)
+display_screen("INST", "ADCS")
+wait(3)
+display_screen("INST", "HS", 400, 0)
+wait(3)
+clear_screen("INST", "ADCS")
+wait(3)
+display_screen("INST", "IMAGE")
+wait(3)
+clear_all_screens()
+wait(3)
+definition = """
+SCREEN AUTO AUTO 1.0
+
+VERTICALBOX "Test Screen"
+  LABELVALUE INST HEALTH_STATUS TEMP1
+  LABELVALUE INST HEALTH_STATUS RECEIVED_TIMEFORMATTED WITH_UNITS 30
+END
+"""
+local_screen("TEST", definition)
+wait(3)
+clear_all_screens()
+create_screen("INST", "TEST", definition)
+display_screen("INST", "TEST")
+wait(3)
+clear_all_screens()
+delete_screen("INST", "TEST")
+display_screen("INST", "TEST")  # Expected to fail because new screen was deleted

data/targets/INST/procedures_py/stash.py

@@ -0,0 +1,24 @@
+from openc3.script import *
+
+# 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(f"'{stash_get('key1')}' == 'val1'")
+check_expression(f"'{stash_get('key2')}' == 'val2'")
+check_expression(f"{stash_keys()} == ['key1', 'key2']")
+stash_set("key1", 1)
+stash_set("key2", 2)
+check_expression(f"{stash_all()} == {{'key1':1, 'key2':2}}")
+stash_delete("key2")
+check_expression(f"{stash_get('key2')} == None")
+stash_delete("key1")
+data = [1, 2, [3, 4]]
+stash_set("ary", data)
+check_expression(f"{stash_get('ary')} == {data}")
+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(f"{stash_get('hash')} == {hash}")
+stash_delete("hash")

data/targets/INST/procedures_py/target_file.py

@@ -0,0 +1,26 @@
+from openc3.script import *
+
+put_target_file("INST/test.txt", "this is a string test")
+download_file("INST/test.txt")  # download via path
+file = get_target_file("INST/test.txt")
+print(file.read)
+file.rewind  # rewind so download_file can read
+download_file(file)  # download using file
+file.delete
+delete_target_file("INST/test.txt")
+
+save_file = Tempfile.new("test")
+save_file.write("this is a Io test")
+save_file.rewind
+put_target_file("INST/test.txt", save_file)
+save_file.delete
+file = get_target_file("INST/test.txt")
+print(file.read)
+file.delete
+delete_target_file("INST/test.txt")
+
+put_target_file("INST/test.bin", "\x00\x01\x02\x03\xFF\xEE\xDD\xCC")
+file = get_target_file("INST/test.bin")
+print(file.read.formatted)
+file.delete
+delete_target_file("INST/test.bin")

data/targets/INST/procedures_py/utilities/clear.py

@@ -0,0 +1,9 @@
+from openc3.script import *
+
+
+def clear():
+    # Command the collect
+    cmd("<%= target_name %> CLEAR")
+
+    # Wait for telemetry to update
+    wait_check("<%= target_name %> HEALTH_STATUS COLLECTS == 0", 10)

data/targets/INST/procedures_py/utilities/collect.py

@@ -0,0 +1,17 @@
+from openc3.script import *
+
+load_utility("<%= target_name %>/procedures_py/utilities/clear.py")
+
+
+def collect(type, duration, call_clear=False):
+    # Get the current collects telemetry point
+    collects = tlm("<%= target_name %> HEALTH_STATUS COLLECTS")
+
+    # Command the collect
+    cmd(f"<%= target_name %> COLLECT with TYPE {type}, DURATION {duration}")
+
+    # Wait for telemetry to update
+    wait_check(f"<%= target_name %> HEALTH_STATUS COLLECTS == {collects + 1}", 10)
+
+    if call_clear:
+        clear()