Merge branch 'main' into script_apis

OpenC3 · Jan 28, 2025 · 6b2b905 · 6b2b905
2 parents 23c43ba + 6de3c5c
commit 6b2b905
Show file tree

Hide file tree

Showing 111 changed files with 786 additions and 137 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -110,7 +110,7 @@ jobs:
         env:
           GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
       - name: Publish python package
-        uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}

diff --git a/docs.openc3.com/docs/configuration/command.md b/docs.openc3.com/docs/configuration/command.md
@@ -214,6 +214,17 @@ takes extra parameters and must always implement the `call` method. The conversi
 factor is applied to the value entered by the user before it is written into
 the binary command packet and sent.
 
+When applying a write_conversion sometimes the data type changes,
+e.g. creating a UINT from an input STRING (for an example of this see
+[ip_write_conversion.rb](https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/conversions/ip_write_conversion.rb)
+or [ip_write_conversion.py](https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/conversions/ip_write_conversion.py)).
+In this case, the command definition data type is UINT and the min, max values don't matter
+(but must be given) so are typically set to MIN MAX. The default value is important
+and should be specified as a string. For a full example see the IP_ADDRESS parameter
+in the TIME_OFFSET command definition of the COSMOS Demo
+[INST inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt)
+or [INST2 inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt).
+
 :::info Multiple write conversions on command parameters
 When a command is built, each item gets written (and write conversions are run)
 to set the default value. Then items are written (again write conversions are run)

diff --git a/docs.openc3.com/docs/configuration/table.md b/docs.openc3.com/docs/configuration/table.md
@@ -218,6 +218,17 @@ takes extra parameters and must always implement the `call` method. The conversi
 factor is applied to the value entered by the user before it is written into
 the binary command packet and sent.
 
+When applying a write_conversion sometimes the data type changes,
+e.g. creating a UINT from an input STRING (for an example of this see
+[ip_write_conversion.rb](https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/conversions/ip_write_conversion.rb)
+or [ip_write_conversion.py](https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/conversions/ip_write_conversion.py)).
+In this case, the command definition data type is UINT and the min, max values don't matter
+(but must be given) so are typically set to MIN MAX. The default value is important
+and should be specified as a string. For a full example see the IP_ADDRESS parameter
+in the TIME_OFFSET command definition of the COSMOS Demo
+[INST inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt)
+or [INST2 inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt).
+
 :::info Multiple write conversions on command parameters
 When a command is built, each item gets written (and write conversions are run)
 to set the default value. Then items are written (again write conversions are run)

diff --git a/docs.openc3.com/docs/guides/scripting-api.md b/docs.openc3.com/docs/guides/scripting-api.md
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/assets/js/5fe211ef.a50aa370.js → docs/assets/js/5fe211ef.b8d96eae.js b/docs/assets/js/5fe211ef.a50aa370.js → docs/assets/js/5fe211ef.b8d96eae.js
diff --git a/docs/assets/js/72c6d8a8.277788ca.js b/docs/assets/js/72c6d8a8.277788ca.js
diff --git a/docs/assets/js/72c6d8a8.bcc2b69f.js b/docs/assets/js/72c6d8a8.bcc2b69f.js
diff --git a/docs/assets/js/main.1f406a5d.js b/docs/assets/js/main.1f406a5d.js
diff --git a/docs/assets/js/main.ab67284f.js b/docs/assets/js/main.ab67284f.js
diff --git a/docs/assets/js/runtime~main.3ca3256b.js b/docs/assets/js/runtime~main.3ca3256b.js