Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script apis #1803

Merged
merged 20 commits into from
Jan 28, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into script_apis
jmthomas committed Jan 28, 2025
commit 6b2b90526aa263c3ca4977514ae4c82d0d5c0043
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -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 }}
11 changes: 11 additions & 0 deletions docs.openc3.com/docs/configuration/command.md
Original file line number Diff line number Diff line change
@@ -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)
11 changes: 11 additions & 0 deletions docs.openc3.com/docs/configuration/table.md
Original file line number Diff line number Diff line change
@@ -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)
244 changes: 195 additions & 49 deletions docs.openc3.com/docs/guides/scripting-api.md

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion docs/404.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/assets/js/72c6d8a8.277788ca.js

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/js/72c6d8a8.bcc2b69f.js

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/assets/js/main.1f406a5d.js

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions docs/assets/js/main.ab67284f.js

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/assets/js/runtime~main.3ca3256b.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.