openc3-cosmos-tool-docs 6.4.1 → 6.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +4 -1
- data/tools/staticdocs/assets/css/styles.1a361da6.css +1 -0
- data/tools/staticdocs/assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png +0 -0
- data/tools/staticdocs/assets/images/docker-security-bb6d4bdd60a5cd7df87a572159c6369b67bee5735be5a501b25786cabdcd4228.png +0 -0
- data/tools/staticdocs/assets/images/tlm-processing-ce5d4cc16e4a19d9c4f799cc8af975e93eb1c54ba0d43acbc31cc048667b223d.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5dd06a57.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.ed3ac5fa.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ef66a55c.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.43788fd9.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.7aacaf90.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.7aa50138.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.ff33b528.js +1 -0
- data/tools/staticdocs/assets/js/13196248.14de6ce1.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.2dafa283.js +1 -0
- data/tools/staticdocs/assets/js/1602.502ef9b1.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.d99a363c.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.d91543a5.js +1 -0
- data/tools/staticdocs/assets/js/2124.545702e0.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.5eb8d876.js +1 -0
- data/tools/staticdocs/assets/js/2368.fd1bb46a.js +4 -0
- data/tools/staticdocs/assets/js/26b8abb2.021651f5.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.1eee5bcb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.7f30b517.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.4f30c5da.js +1 -0
- data/tools/staticdocs/assets/js/3687.8bc61ef3.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.dfbe9bb7.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.42b05c12.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e55efd5d.js +1 -0
- data/tools/staticdocs/assets/js/42170351.2de491d4.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.f7c95691.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.2da36c11.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.7cc2c5cc.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.29533a03.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.62d9a8b8.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.40e0caf8.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.64ea5a52.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.2d29f3fb.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.ec0009ac.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.1c205c60.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.32ded6d5.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.b2a62736.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.e0eb7741.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7719.0d312792.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.a0dfbdf7.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.32ca371f.js +1 -0
- data/tools/staticdocs/assets/js/{89e76475.e1b0dbdb.js → 89e76475.20b3a636.js} +1 -1
- data/tools/staticdocs/assets/js/8f7843ee.6d7c9cd4.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.75b12400.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.0eee94ba.js +1 -0
- data/tools/staticdocs/assets/js/97535711.630cee4d.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.73b5cd90.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.6b6404ff.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.715fc441.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.76d13f14.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.3b3e7379.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.da1da6f1.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.bc122746.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.4e8142cb.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.4a10f506.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.08749f15.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.776bc00f.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.ce400445.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.a201a4a7.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.77326c08.js +1 -0
- data/tools/staticdocs/assets/js/{c2598f55.812cdcd1.js → c2598f55.85419dc8.js} +1 -1
- data/tools/staticdocs/assets/js/cb8c3f08.73cefada.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.dc2adfcc.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.57f5e162.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.73bb876f.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.e348c06d.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.885590b1.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1143a9d4.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.0ffb9759.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.fe602968.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.a115a366.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.1aefa4e7.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.9c957b0c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.ddc630ca.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.f9c2d1fc.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.a4d98d69.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.656b4fa3.js +1 -0
- data/tools/staticdocs/assets/js/main.ba1fa268.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.ca894d1e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +21 -18
- data/tools/staticdocs/docs/configuration/command.html +35 -35
- data/tools/staticdocs/docs/configuration/conversions.html +156 -0
- data/tools/staticdocs/docs/configuration/format.html +18 -15
- data/tools/staticdocs/docs/configuration/interfaces.html +34 -31
- data/tools/staticdocs/docs/configuration/plugins.html +39 -36
- data/tools/staticdocs/docs/configuration/protocols.html +28 -25
- data/tools/staticdocs/docs/configuration/ssl-tls.html +10 -6
- data/tools/staticdocs/docs/configuration/table.html +19 -22
- data/tools/staticdocs/docs/configuration/target.html +11 -8
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +72 -69
- data/tools/staticdocs/docs/configuration/telemetry.html +40 -40
- data/tools/staticdocs/docs/configuration.html +4 -1
- data/tools/staticdocs/docs/development/curl.html +12 -9
- data/tools/staticdocs/docs/development/developing.html +15 -12
- data/tools/staticdocs/docs/development/json-api.html +8 -5
- data/tools/staticdocs/docs/development/log-structure.html +5 -2
- data/tools/staticdocs/docs/development/roadmap.html +5 -2
- data/tools/staticdocs/docs/development/streaming-api.html +13 -10
- data/tools/staticdocs/docs/development/testing.html +15 -12
- data/tools/staticdocs/docs/development.html +4 -1
- data/tools/staticdocs/docs/getting-started/cli.html +16 -13
- data/tools/staticdocs/docs/getting-started/generators.html +19 -16
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +15 -12
- data/tools/staticdocs/docs/getting-started/installation.html +7 -4
- data/tools/staticdocs/docs/getting-started/key-concepts.html +6 -3
- data/tools/staticdocs/docs/getting-started/podman.html +19 -16
- data/tools/staticdocs/docs/getting-started/requirements.html +7 -4
- data/tools/staticdocs/docs/getting-started/upgrading.html +23 -15
- data/tools/staticdocs/docs/getting-started.html +4 -1
- data/tools/staticdocs/docs/guides/bridges.html +7 -4
- data/tools/staticdocs/docs/guides/cfs.html +19 -16
- data/tools/staticdocs/docs/guides/custom-widgets.html +54 -16
- data/tools/staticdocs/docs/guides/dynamic-packets.html +9 -6
- data/tools/staticdocs/docs/guides/exposing-microservices.html +9 -6
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +6 -3
- data/tools/staticdocs/docs/guides/local-mode.html +6 -3
- data/tools/staticdocs/docs/guides/logging.html +5 -2
- data/tools/staticdocs/docs/guides/monitoring.html +11 -8
- data/tools/staticdocs/docs/guides/performance.html +6 -3
- data/tools/staticdocs/docs/guides/raspberrypi.html +6 -3
- data/tools/staticdocs/docs/guides/reference-architectures.html +35 -0
- data/tools/staticdocs/docs/guides/script-writing.html +46 -43
- data/tools/staticdocs/docs/guides/scripting-api.html +627 -433
- data/tools/staticdocs/docs/guides.html +4 -1
- data/tools/staticdocs/docs/meta/contributing.html +10 -7
- data/tools/staticdocs/docs/meta/licenses.html +6 -3
- data/tools/staticdocs/docs/meta/philosophy.html +5 -2
- data/tools/staticdocs/docs/meta/xtce.html +7 -4
- data/tools/staticdocs/docs/meta.html +4 -1
- data/tools/staticdocs/docs/privacy.html +5 -2
- data/tools/staticdocs/docs/tools/admin.html +5 -2
- data/tools/staticdocs/docs/tools/autonomic.html +5 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +5 -2
- data/tools/staticdocs/docs/tools/calendar.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +5 -2
- data/tools/staticdocs/docs/tools/command_history.html +5 -2
- data/tools/staticdocs/docs/tools/data-extractor.html +5 -2
- data/tools/staticdocs/docs/tools/data-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/handbooks.html +5 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +5 -2
- data/tools/staticdocs/docs/tools/packet-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/script-runner.html +9 -6
- data/tools/staticdocs/docs/tools/table-manager.html +6 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +5 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +5 -2
- data/tools/staticdocs/docs/tools.html +4 -1
- data/tools/staticdocs/docs.html +6 -8
- data/tools/staticdocs/img/cmd-processing.png +0 -0
- data/tools/staticdocs/img/docker-local-security.png +0 -0
- data/tools/staticdocs/img/docker-security.png +0 -0
- data/tools/staticdocs/img/tlm-processing.png +0 -0
- data/tools/staticdocs/index.html +4 -1
- data/tools/staticdocs/lunr-index-1748640055686.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +5 -2
- data/tools/staticdocs/search-doc-1748640055686.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +94 -83
- data/tools/staticdocs/assets/css/styles.1de6b959.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.43fd7635.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.5cfabd67.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.0e2ea47d.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.5515d5e3.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.7697df48.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.f81b787b.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.e7943c80.js +0 -1
- data/tools/staticdocs/assets/js/13196248.ea83002e.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.eb5250f4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.d91f6c3e.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.0df9587b.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.7f8d4cb0.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.1772f030.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.fcf47881.js +0 -1
- data/tools/staticdocs/assets/js/3969.afdd070b.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.c3455b97.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.5ed2e9b5.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.f7b3ff17.js +0 -1
- data/tools/staticdocs/assets/js/42170351.fbc05869.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.60fa883f.js +0 -1
- data/tools/staticdocs/assets/js/5205.c6f31e57.js +0 -1
- data/tools/staticdocs/assets/js/5328.3e2a53eb.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.fe331a71.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.ef91ba12.js +0 -1
- data/tools/staticdocs/assets/js/5761.e7fabbc9.js +0 -4
- data/tools/staticdocs/assets/js/5b233ba7.9d6ba314.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.8b51f7c0.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.63b46202.js +0 -1
- data/tools/staticdocs/assets/js/651.a043d7b1.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.1318b398.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.1e950fcb.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.6a77064a.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.0376a397.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.6439052e.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.b6fcfc30.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.324643a8.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.607160d3.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.27d9d599.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.abe30983.js +0 -1
- data/tools/staticdocs/assets/js/9357.9a7e89b5.js +0 -101
- data/tools/staticdocs/assets/js/9424f0b3.3683501c.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.0e04c58d.js +0 -1
- data/tools/staticdocs/assets/js/97535711.e595488c.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.841b4a2e.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.36405219.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.821f7504.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.cfa50691.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.b418f772.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.805dc1ba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.ef9b0f38.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.57d6e194.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.c648533a.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.a9228642.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.4c0bb1dd.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.8ad39448.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.0575c394.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.07d1c9e9.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.59af1749.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.da892cde.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.a58b9bbd.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.9fef8263.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.c74b62b1.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.e812e6e7.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.80a50660.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.8df86c99.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.5db8667e.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.f1eed806.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.75e9fc53.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.9e4e6681.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.d3a1e4bc.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.49804e96.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.124ffe26.js +0 -1
- data/tools/staticdocs/assets/js/main.b1edeb65.js +0 -36
- data/tools/staticdocs/assets/js/runtime~main.3629ffb4.js +0 -1
- data/tools/staticdocs/lunr-index-1747245438937.json +0 -1
- data/tools/staticdocs/search-doc-1747245438937.json +0 -1
@@ -1,4 +1,10 @@
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/command" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Commands | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/configuration/command><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Commands | OpenC3 Docs"><meta data-rh=true name=description content="Command definition file format and keywords"><meta data-rh=true property=og:description content="Command definition file format and keywords"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.3629ffb4.js defer></script><script src=/tools/staticdocs/assets/js/main.b1edeb65.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Commands</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Commands</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=command-definition-files>Command Definition Files<a href=#command-definition-files class=hash-link aria-label="Direct link to Command Definition Files" title="Direct link to Command Definition Files"></a></h2>
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/command" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.0"><title data-rh=true>Commands | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/configuration/command><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Commands | OpenC3 Docs"><meta data-rh=true name=description content="Command definition file format and keywords"><meta data-rh=true property=og:description content="Command definition file format and keywords"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/command hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/command","name":"Commands","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.ca894d1e.js defer></script><script src=/tools/staticdocs/assets/js/main.ba1fa268.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
2
|
+
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
3
|
+
</defs></svg>
|
4
|
+
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions>Conversions</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Commands</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Commands</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=command-concepts>Command Concepts<a href=#command-concepts class=hash-link aria-label="Direct link to Command Concepts" title="Direct link to Command Concepts"></a></h2>
|
5
|
+
<p>The COSMOS front end provides multiple ways to send commands. They can come from a script (e.g. in <a href=/tools/staticdocs/docs/tools/script-runner>Script Runner</a>), a tool like <a href=/tools/staticdocs/docs/tools/cmd-sender>Command Sender</a>, or just generally through an API call. These requests will go to the CmdTlmApi Server to start the flow through the rest of the COSMOS architecture and out to the target as follows:</p>
|
6
|
+
<p><img decoding=async loading=lazy alt="Command Processing Diagram" src=/tools/staticdocs/assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png width=781 height=771 class=img__Ss2></p>
|
7
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=command-definition-files>Command Definition Files<a href=#command-definition-files class=hash-link aria-label="Direct link to Command Definition Files" title="Direct link to Command Definition Files"></a></h2>
|
2
8
|
<p>Command definition files define the command packets that can be sent to COSMOS targets. One large file can be used to define the command packets, or multiple files can be used at the user's discretion. Command definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some command files that depend on others, e.g. they override or extend existing commands, they must be named last. The easiest way to do this is to add an extension to an existing file name. For example, if you already have cmd.txt you can create cmd_override.txt for commands that depends on the definitions in cmd.txt. Also note that due to the way the <a href=http://www.asciitable.com/ target=_blank rel="noopener noreferrer">ASCII Table</a> is structured, files beginning with capital letters are processed before lower case letters.</p>
|
3
9
|
<p>When defining command parameters you can choose from the following data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data. The only difference between a STRING and BLOCK is when COSMOS reads the binary command log it stops reading a STRING type when it encounters a null byte (0). This shows up in the text log produced by Data Extractor. Note that this does NOT affect the data COSMOS writes as it's still legal to pass null bytes (0) in STRING parameters.</p>
|
4
10
|
<div style=clear:both></div>
|
@@ -7,7 +13,7 @@
|
|
7
13
|
<p><strong>Defines a new command packet</strong></p>
|
8
14
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target<td>Name of the target this command is associated with<td>True<tr><td>Command<td>Name of this command. Also referred to as its mnemonic. Must be unique to commands to this target. Ideally will be as short and clear as possible.<td>True<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>True<tr><td>Description<td>Description of this command which must be enclosed with quotes<td>False</table>
|
9
15
|
<p>Example Usage:</p>
|
10
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
16
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Start collect"</span><br></span></code></pre></div></div>
|
11
17
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=command-modifiers>COMMAND Modifiers<a href=#command-modifiers class=hash-link aria-label="Direct link to COMMAND Modifiers" title="Direct link to COMMAND Modifiers"></a></h2>
|
12
18
|
<p>The following keywords must follow a COMMAND keyword.</p>
|
13
19
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=parameter>PARAMETER<a href=#parameter class=hash-link aria-label="Direct link to PARAMETER" title="Direct link to PARAMETER"></a></h3>
|
@@ -18,19 +24,19 @@
|
|
18
24
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
19
25
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
20
26
|
<p>Example Usage:</p>
|
21
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
27
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SYNC</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Sync pattern"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Data value"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2.5</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">96</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">96</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"OPENC3"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"The label to apply"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BLOCK</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">192</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BLOCK</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Block of binary data"</span><br></span></code></pre></div></div>
|
22
28
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=parameter-modifiers>PARAMETER Modifiers<a href=#parameter-modifiers class=hash-link aria-label="Direct link to PARAMETER Modifiers" title="Direct link to PARAMETER Modifiers"></a></h3>
|
23
29
|
<p>The following keywords must follow a PARAMETER keyword.</p>
|
24
30
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=format_string>FORMAT_STRING<a href=#format_string class=hash-link aria-label="Direct link to FORMAT_STRING" title="Direct link to FORMAT_STRING"></a></h4>
|
25
31
|
<p><strong>Adds printf style formatting</strong></p>
|
26
32
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Format<td>How to format using printf syntax. For example, '0x%0X' will display the value in hex.<td>True</table>
|
27
33
|
<p>Example Usage:</p>
|
28
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
34
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><br></span></code></pre></div></div>
|
29
35
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=units>UNITS<a href=#units class=hash-link aria-label="Direct link to UNITS" title="Direct link to UNITS"></a></h4>
|
30
36
|
<p><strong>Add displayed units</strong></p>
|
31
37
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Full Name<td>Full name of the units type, e.g. Celsius<td>True<tr><td>Abbreviated<td>Abbreviation for the units, e.g. C<td>True</table>
|
32
38
|
<p>Example Usage:</p>
|
33
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
39
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Celsius </span><span class="token constant" style="color:rgb(130, 170, 255)">C</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Kilometers </span><span class="token constant" style="color:rgb(130, 170, 255)">KM</span><br></span></code></pre></div></div>
|
34
40
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=description>DESCRIPTION<a href=#description class=hash-link aria-label="Direct link to DESCRIPTION" title="Direct link to DESCRIPTION"></a></h4>
|
35
41
|
<p><strong>Override the defined description</strong></p>
|
36
42
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new description<td>True</table>
|
@@ -39,7 +45,7 @@
|
|
39
45
|
<p>Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files.</p>
|
40
46
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Meta Name<td>Name of the metadata to store<td>True<tr><td>Meta Values<td>One or more values to be stored for this Meta Name<td>False</table>
|
41
47
|
<p>Example Usage:</p>
|
42
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
48
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">META</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEST</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"This parameter is for test purposes only"</span><br></span></code></pre></div></div>
|
43
49
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=overlap>OVERLAP<a href=#overlap class=hash-link aria-label="Direct link to OVERLAP" title="Direct link to OVERLAP"></a></h4>
|
44
50
|
<p><div class=right>(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
45
51
|
<p>If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and suppresses the warning message.</p>
|
@@ -48,7 +54,7 @@
|
|
48
54
|
<p>Keys are often <a href=https://en.wikipedia.org/wiki/JSONPath target=_blank rel="noopener noreferrer">JSONPath</a> or <a href=https://en.wikipedia.org/wiki/XPath target=_blank rel="noopener noreferrer">XPath</a> strings</p>
|
49
55
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key string<td>The key to access this item<td>True</table>
|
50
56
|
<p>Example Usage:</p>
|
51
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
57
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> $</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">book</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">title</span><br></span></code></pre></div></div>
|
52
58
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=variable_bit_size>VARIABLE_BIT_SIZE<a href=#variable_bit_size class=hash-link aria-label="Direct link to VARIABLE_BIT_SIZE" title="Direct link to VARIABLE_BIT_SIZE"></a></h4>
|
53
59
|
<p><div class=right>(Since 5.18.0)</div><strong>Marks an item as having its bit size defined by another length item</strong><p></p>
|
54
60
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Length Item Name<td>The name of the associated length item<td>True<tr><td>Length Bits Per Count<td>Bits per count of the length item. Defaults to 8<td>False<tr><td>Length Value Bit Offset<td>Offset in Bits to Apply to Length Field Value. Defaults to 0<td>False</table>
|
@@ -69,7 +75,7 @@
|
|
69
75
|
<p>Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error.</p>
|
70
76
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>The string state name<td>True<tr><td>Value<td>The numerical state value<td>True<tr><td>Hazardous / Disable Messages<td>Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.<br><br>Valid Values: <span class=values>HAZARDOUS</span><td>False<tr><td>Hazardous Description<td>String describing why this state is hazardous<td>False</table>
|
71
77
|
<p>Example Usage:</p>
|
72
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
78
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Enable setting"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1024</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"String parameter"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE_MESSAGES</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ARM LASER"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ARM LASER"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HAZARDOUS</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Arming the laser is an eye safety hazard"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"FIRE LASER"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"FIRE LASER"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HAZARDOUS</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"WARNING! Laser will be fired!"</span><br></span></code></pre></div></div>
|
73
79
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=write_conversion>WRITE_CONVERSION<a href=#write_conversion class=hash-link aria-label="Direct link to WRITE_CONVERSION" title="Direct link to WRITE_CONVERSION"></a></h4>
|
74
80
|
<p><strong>Applies a conversion when writing the current command parameter</strong></p>
|
75
81
|
<p>Conversions are implemented in a custom Ruby or Python file which should be
|
@@ -77,7 +83,7 @@ located in the target's lib folder. The class must inherit from Conversion.
|
|
77
83
|
It must implement the <code>initialize</code> (Ruby) or <code>__init__</code> (Python) method if it
|
78
84
|
takes extra parameters and must always implement the <code>call</code> method. The conversion
|
79
85
|
factor is applied to the value entered by the user before it is written into
|
80
|
-
the binary command packet and sent.</p>
|
86
|
+
the binary command packet and sent. For more information see the <a href=/tools/staticdocs/docs/configuration/conversions>Conversion</a> documentation.</p>
|
81
87
|
<p>When applying a write_conversion sometimes the data type changes,
|
82
88
|
e.g. creating a UINT from an input STRING (for an example of this see
|
83
89
|
<a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/conversions/ip_write_conversion.rb target=_blank rel="noopener noreferrer">ip_write_conversion.rb</a>
|
@@ -94,23 +100,17 @@ with user provided values. Thus write conversions can be run twice. Also there a
|
|
94
100
|
no guarantees which parameters have already been written. The packet itself has a
|
95
101
|
given_values() method which can be used to retrieve a hash of the user provided
|
96
102
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
97
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Class Filename<td>The filename which contains the Ruby or Python class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'.<td>True<tr><td>Parameter<td>Additional parameter values for the conversion which are passed to the class constructor.<td>False</table>
|
103
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Class Filename<td>The filename which contains the Ruby or Python class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'. Note the built-in Python conversions must specify the full path to the file, e.g. 'openc3/conversions/bit_reverse_conversion.py'.<td>True<tr><td>Parameter<td>Additional parameter values for the conversion which are passed to the class constructor.<td>False</table>
|
98
104
|
<p>Ruby Example:</p>
|
99
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
105
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">WRITE_CONVERSION</span><span class="token plain"> ip_write_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span></code></pre></div></div>
|
100
106
|
<p>Python Example:</p>
|
101
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
107
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">WRITE_CONVERSION openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">conversions</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ip_write_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br></span></code></pre></div></div>
|
102
108
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=poly_write_conversion>POLY_WRITE_CONVERSION<a href=#poly_write_conversion class=hash-link aria-label="Direct link to POLY_WRITE_CONVERSION" title="Direct link to POLY_WRITE_CONVERSION"></a></h4>
|
103
109
|
<p><strong>Adds a polynomial conversion factor to the current command parameter</strong></p>
|
104
|
-
<p>
|
105
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>C0<td>Coefficient<td>True<tr><td>Cx<td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.<td>False</table>
|
106
|
-
<p>Example Usage:</p>
|
107
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.25</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
110
|
+
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#polynomial_conversion>Polynomial Conversion</a> for more information.</p>
|
108
111
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=seg_poly_write_conversion>SEG_POLY_WRITE_CONVERSION<a href=#seg_poly_write_conversion class=hash-link aria-label="Direct link to SEG_POLY_WRITE_CONVERSION" title="Direct link to SEG_POLY_WRITE_CONVERSION"></a></h4>
|
109
112
|
<p><strong>Adds a segmented polynomial conversion factor to the current command parameter</strong></p>
|
110
|
-
<p>
|
111
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Lower Bound<td>Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound.<td>True<tr><td>C0<td>Coefficient<td>True<tr><td>Cx<td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.<td>False</table>
|
112
|
-
<p>Example Usage:</p>
|
113
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SEG_POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.25</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values < 50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">SEG_POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.275</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values >= 50 and < 100</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">SEG_POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.3</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values >= 100</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
113
|
+
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#segmented_polynomial_conversion>Segmented Polynomial Conversion</a> for more information.</p>
|
114
114
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=generic_write_conversion_start>GENERIC_WRITE_CONVERSION_START<a href=#generic_write_conversion_start class=hash-link aria-label="Direct link to GENERIC_WRITE_CONVERSION_START" title="Direct link to GENERIC_WRITE_CONVERSION_START"></a></h4>
|
115
115
|
<p><strong>Start a generic write conversion</strong></p>
|
116
116
|
<p>Adds a generic conversion function to the current command parameter.
|
@@ -130,9 +130,9 @@ given_values() method which can be used to retrieve a hash of the user provided
|
|
130
130
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
131
131
|
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>warning</div><div class=admonitionContent_bl22><p>Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance.</div></div>
|
132
132
|
<p>Ruby Example:</p>
|
133
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
133
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ITEM1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xFFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_WRITE_CONVERSION_START</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">value </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">to_i </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Convert the value by a scale factor</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_WRITE_CONVERSION_END</span><br></span></code></pre></div></div>
|
134
134
|
<p>Python Example:</p>
|
135
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
135
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">APPEND_PARAMETER ITEM1 </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> UINT </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xFFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> GENERIC_WRITE_CONVERSION_START</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">int</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">value </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Convert the value by a scale factor</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> GENERIC_WRITE_CONVERSION_END</span><br></span></code></pre></div></div>
|
136
136
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=generic_write_conversion_end>GENERIC_WRITE_CONVERSION_END<a href=#generic_write_conversion_end class=hash-link aria-label="Direct link to GENERIC_WRITE_CONVERSION_END" title="Direct link to GENERIC_WRITE_CONVERSION_END"></a></h4>
|
137
137
|
<p><strong>Complete a generic write conversion</strong></p>
|
138
138
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=overflow>OVERFLOW<a href=#overflow class=hash-link aria-label="Direct link to OVERFLOW" title="Direct link to OVERFLOW"></a></h4>
|
@@ -140,7 +140,7 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
140
140
|
<p>By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be written, e.g. you can successfully write 255 to a 8 bit signed value.</p>
|
141
141
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Behavior<td>How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.<br><br>Valid Values: <span class=values>ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE</span><td>True</table>
|
142
142
|
<p>Example Usage:</p>
|
143
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
143
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">OVERFLOW</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUNCATE</span><br></span></code></pre></div></div>
|
144
144
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_parameter>APPEND_PARAMETER<a href=#append_parameter class=hash-link aria-label="Direct link to APPEND_PARAMETER" title="Direct link to APPEND_PARAMETER"></a></h3>
|
145
145
|
<p><strong>Defines a command parameter in the current command packet</strong></p>
|
146
146
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the command.<td>True<tr><td>Bit Size<td>Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'.<td>True<tr><td>Data Type<td>Data Type of this parameter<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span><td>True</table>
|
@@ -149,7 +149,7 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
149
149
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
150
150
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
151
151
|
<p>Example Usage:</p>
|
152
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
152
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SYNC</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Sync pattern"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2.5</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"OPENC3"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"The label to apply"</span><br></span></code></pre></div></div>
|
153
153
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=id_parameter>ID_PARAMETER<a href=#id_parameter class=hash-link aria-label="Direct link to ID_PARAMETER" title="Direct link to ID_PARAMETER"></a></h3>
|
154
154
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
155
155
|
<p>ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified.</p>
|
@@ -159,7 +159,7 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
159
159
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
160
160
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
161
161
|
<p>Example Usage:</p>
|
162
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
162
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPCODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Opcode identifier"</span><br></span></code></pre></div></div>
|
163
163
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_id_parameter>APPEND_ID_PARAMETER<a href=#append_id_parameter class=hash-link aria-label="Direct link to APPEND_ID_PARAMETER" title="Direct link to APPEND_ID_PARAMETER"></a></h3>
|
164
164
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
165
165
|
<p>ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified.</p>
|
@@ -169,29 +169,29 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
169
169
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
170
170
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
171
171
|
<p>Example Usage:</p>
|
172
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
172
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPCODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Opcode identifier"</span><br></span></code></pre></div></div>
|
173
173
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=array_parameter>ARRAY_PARAMETER<a href=#array_parameter class=hash-link aria-label="Direct link to ARRAY_PARAMETER" title="Direct link to ARRAY_PARAMETER"></a></h3>
|
174
174
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
175
175
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the command.<td>True<tr><td>Bit Offset<td>Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters.<td>True<tr><td>Item Bit Size<td>Bit size of each array item<td>True<tr><td>Item Data Type<td>Data Type of each array item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Array Bit Size<td>Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value.<td>True<tr><td>Description<td>Description which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
176
176
|
<p>Example Usage:</p>
|
177
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
177
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">640</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Array of 10 64bit floats"</span><br></span></code></pre></div></div>
|
178
178
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_array_parameter>APPEND_ARRAY_PARAMETER<a href=#append_array_parameter class=hash-link aria-label="Direct link to APPEND_ARRAY_PARAMETER" title="Direct link to APPEND_ARRAY_PARAMETER"></a></h3>
|
179
179
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
180
180
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the command.<td>True<tr><td>Item Bit Size<td>Bit size of each array item<td>True<tr><td>Item Data Type<td>Data Type of each array item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Array Bit Size<td>Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value.<td>True<tr><td>Description<td>Description which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
181
181
|
<p>Example Usage:</p>
|
182
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
182
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ARRAY_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">640</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Array of 10 64bit floats"</span><br></span></code></pre></div></div>
|
183
183
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=select_parameter>SELECT_PARAMETER<a href=#select_parameter class=hash-link aria-label="Direct link to SELECT_PARAMETER" title="Direct link to SELECT_PARAMETER"></a></h3>
|
184
184
|
<p><strong>Selects an existing command parameter for editing</strong></p>
|
185
185
|
<p>Must be used in conjunction with SELECT_COMMAND to first select the packet. Typically used to override generated values or make specific changes to commands that only affect a particular instance of a target used multiple times.</p>
|
186
186
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Parameter<td>Name of the parameter to select for modification<td>True</table>
|
187
187
|
<p>Example Usage:</p>
|
188
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
188
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SELECT_COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SELECT_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DURATION</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Add units</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Seconds </span><span class="token constant" style="color:rgb(130, 170, 255)">S</span><br></span></code></pre></div></div>
|
189
189
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=delete_parameter>DELETE_PARAMETER<a href=#delete_parameter class=hash-link aria-label="Direct link to DELETE_PARAMETER" title="Direct link to DELETE_PARAMETER"></a></h3>
|
190
190
|
<p><div class=right>(Since 4.4.1)</div><strong>Deletes an existing command parameter from the packet definition</strong><p></p>
|
191
191
|
<p>Deleting a parameter from the command definition does not remove the defined space for that parameter. Thus unless you redefine a new parameter, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_COMMAND and then PARAMETER to define a new parameter.</p>
|
192
192
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Parameter<td>Name of the parameter to delete<td>True</table>
|
193
193
|
<p>Example Usage:</p>
|
194
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
194
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SELECT_COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DELETE_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DURATION</span><br></span></code></pre></div></div>
|
195
195
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=hidden>HIDDEN<a href=#hidden class=hash-link aria-label="Direct link to HIDDEN" title="Direct link to HIDDEN"></a></h3>
|
196
196
|
<p><strong>Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator</strong></p>
|
197
197
|
<p>Hidden commands do not appear in the Script Runner popup helper when writing scripts. The command still exists in the system and can be sent by scripts.</p>
|
@@ -205,7 +205,7 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
205
205
|
<p>Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files.</p>
|
206
206
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Meta Name<td>Name of the metadata to store<td>True<tr><td>Meta Values<td>One or more values to be stored for this Meta Name<td>False</table>
|
207
207
|
<p>Example Usage:</p>
|
208
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
208
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">META</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FSW_TYPE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"struct command"</span><br></span></code></pre></div></div>
|
209
209
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=hazardous>HAZARDOUS<a href=#hazardous class=hash-link aria-label="Direct link to HAZARDOUS" title="Direct link to HAZARDOUS"></a></h3>
|
210
210
|
<p><strong>Designates the current command as hazardous</strong></p>
|
211
211
|
<p>Sending a hazardous command causes a dialog asking for confirmation before sending the command</p>
|
@@ -245,15 +245,15 @@ values to the command. That can be used to check parameter values passed in.</di
|
|
245
245
|
<p>Validator class is used to validate the command success or failure with both a pre_check and post_check method.</p>
|
246
246
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Class Filename<td>The filename which contains the Ruby or Python class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'command_validator.rb' should contain 'class CommandValidator'.<td>True<tr><td>Argument<td>Additional argument passed to the validator class constructor<td>False</table>
|
247
247
|
<p>Ruby Example:</p>
|
248
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALIDATOR</span><span class="token plain"> custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Defined </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">require</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'openc3/packets/command_validator'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">CustomValidator</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain"> OpenC3</span><span class="token double-colon punctuation" style="color:rgb(199, 146, 234)">::</span><span class="token plain">CommandValidator</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Both the pre_check and post_check are passed the command packet that was sent</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># You can inspect the command in your checks as follows:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.target_name => target name</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.packet_name => packet name (command name)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM") => converted value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM", :RAW) => raw value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">pre_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM is 0"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@cmd_acpt_cnt</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT CMD_ACPT_CNT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">post_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> wait_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT CMD_ACPT_CNT > </span><span class="token string-literal interpolation delimiter punctuation" style="color:rgb(199, 146, 234)">#{</span><span class="token string-literal interpolation content variable" style="color:rgb(214, 222, 235)">@cmd_acpt_cnt</span><span class="token string-literal interpolation delimiter punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
248
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALIDATOR</span><span class="token plain"> custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Defined </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">require</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'openc3/packets/command_validator'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">CustomValidator</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain"> OpenC3</span><span class="token double-colon punctuation" style="color:rgb(199, 146, 234)">::</span><span class="token plain">CommandValidator</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Both the pre_check and post_check are passed the command packet that was sent</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># You can inspect the command in your checks as follows:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.target_name => target name</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.packet_name => packet name (command name)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM") => converted value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM", :RAW) => raw value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">pre_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM is 0"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@cmd_acpt_cnt</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT CMD_ACPT_CNT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">post_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> wait_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TGT PKT CMD_ACPT_CNT > </span><span class="token string-literal interpolation delimiter punctuation" style="color:rgb(199, 146, 234)">#{</span><span class="token string-literal interpolation content variable" style="color:rgb(214, 222, 235)">@cmd_acpt_cnt</span><span class="token string-literal interpolation delimiter punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
|
249
249
|
<p>Python Example:</p>
|
250
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
250
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">VALIDATOR custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Defined </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> custom_validator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">CustomValidator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">CommandValidator</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Both the pre_check and post_check are passed the command packet that was sent</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># You can inspect the command in your checks as follows:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.target_name => target name</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.packet_name => packet name (command name)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM") => converted value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># packet.read("ITEM", :RAW) => raw value</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">pre_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> command</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">False</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"TGT PKT ITEM is 0"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">cmd_acpt_cnt </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> tlm</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST HEALTH_STATUS CMD_ACPT_CNT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">post_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> command</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> wait_check</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">f"INST HEALTH_STATUS CMD_ACPT_CNT > </span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string-interpolation interpolation">self</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token string-interpolation interpolation">cmd_acpt_cnt</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><br></span></code></pre></div></div>
|
251
251
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=select_command>SELECT_COMMAND<a href=#select_command class=hash-link aria-label="Direct link to SELECT_COMMAND" title="Direct link to SELECT_COMMAND"></a></h2>
|
252
252
|
<p><strong>Selects an existing command packet for editing</strong></p>
|
253
253
|
<p>Typically used in a separate configuration file from where the original command is defined to override or add to the existing command definition. Must be used in conjunction with SELECT_PARAMETER to change an individual parameter.</p>
|
254
254
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Name of the target this command is associated with<td>True<tr><td>Command Name<td>Name of the command to select<td>True</table>
|
255
255
|
<p>Example Usage:</p>
|
256
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
256
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SELECT_COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SELECT_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DURATION</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Add units</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Seconds </span><span class="token constant" style="color:rgb(130, 170, 255)">S</span><br></span></code></pre></div></div>
|
257
257
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=example-file>Example File<a href=#example-file class=hash-link aria-label="Direct link to Example File" title="Direct link to Example File"></a></h2>
|
258
258
|
<p><strong>Example File: TARGET/cmd_tlm/cmd.txt</strong></p>
|
259
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_DATA</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Commands my target to collect data"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ANGLE OF INSTRUMENT IN DEGREES"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.01745</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DATA COLLECTION MODE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NORMAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DIAG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NOOP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Do Nothing"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">101</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DUMMY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTINGS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Set the Settings"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5.</span><span class="token plain">times </span><span class="token keyword" style="color:rgb(127, 219, 202)">do</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain">x</span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">%></span><br></span><span class=token-line style=color:#d6deeb><span class="token string-literal string" style="color:rgb(173, 219, 103)"> APPEND_PARAMETER SETTING<%= x %></span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Setting <%= x %>"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/command.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/target><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Targets</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/telemetry><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Telemetry</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#command-definition-files class="table-of-contents__link toc-highlight">Command Definition Files</a><li><a href=#command class="table-of-contents__link toc-highlight">COMMAND</a><li><a href=#command-modifiers class="table-of-contents__link toc-highlight">COMMAND Modifiers</a><ul><li><a href=#parameter class="table-of-contents__link toc-highlight">PARAMETER</a><li><a href=#parameter-modifiers class="table-of-contents__link toc-highlight">PARAMETER Modifiers</a><ul><li><a href=#format_string class="table-of-contents__link toc-highlight">FORMAT_STRING</a><li><a href=#units class="table-of-contents__link toc-highlight">UNITS</a><li><a href=#description class="table-of-contents__link toc-highlight">DESCRIPTION</a><li><a href=#meta class="table-of-contents__link toc-highlight">META</a><li><a href=#overlap class="table-of-contents__link toc-highlight">OVERLAP</a><li><a href=#key class="table-of-contents__link toc-highlight">KEY</a><li><a href=#variable_bit_size class="table-of-contents__link toc-highlight">VARIABLE_BIT_SIZE</a><li><a href=#required class="table-of-contents__link toc-highlight">REQUIRED</a><li><a href=#minimum_value class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a><li><a href=#maximum_value class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a><li><a href=#default_value class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a><li><a href=#state class="table-of-contents__link toc-highlight">STATE</a><li><a href=#write_conversion class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a><li><a href=#poly_write_conversion class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a><li><a href=#seg_poly_write_conversion class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a><li><a href=#generic_write_conversion_start class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a><li><a href=#generic_write_conversion_end class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a><li><a href=#overflow class="table-of-contents__link toc-highlight">OVERFLOW</a></ul><li><a href=#append_parameter class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a><li><a href=#id_parameter class="table-of-contents__link toc-highlight">ID_PARAMETER</a><li><a href=#append_id_parameter class="table-of-contents__link toc-highlight">APPEND_ID_PARAMETER</a><li><a href=#array_parameter class="table-of-contents__link toc-highlight">ARRAY_PARAMETER</a><li><a href=#append_array_parameter class="table-of-contents__link toc-highlight">APPEND_ARRAY_PARAMETER</a><li><a href=#select_parameter class="table-of-contents__link toc-highlight">SELECT_PARAMETER</a><li><a href=#delete_parameter class="table-of-contents__link toc-highlight">DELETE_PARAMETER</a><li><a href=#hidden class="table-of-contents__link toc-highlight">HIDDEN</a><li><a href=#disabled class="table-of-contents__link toc-highlight">DISABLED</a><li><a href=#disable_messages class="table-of-contents__link toc-highlight">DISABLE_MESSAGES</a><li><a href=#meta-1 class="table-of-contents__link toc-highlight">META</a><li><a href=#hazardous class="table-of-contents__link toc-highlight">HAZARDOUS</a><li><a href=#accessor class="table-of-contents__link toc-highlight">ACCESSOR</a><li><a href=#template class="table-of-contents__link toc-highlight">TEMPLATE</a><li><a href=#template_file class="table-of-contents__link toc-highlight">TEMPLATE_FILE</a><li><a href=#response class="table-of-contents__link toc-highlight">RESPONSE</a><li><a href=#error_response class="table-of-contents__link toc-highlight">ERROR_RESPONSE</a><li><a href=#related_item class="table-of-contents__link toc-highlight">RELATED_ITEM</a><li><a href=#screen class="table-of-contents__link toc-highlight">SCREEN</a><li><a href=#virtual class="table-of-contents__link toc-highlight">VIRTUAL</a><li><a href=#restricted class="table-of-contents__link toc-highlight">RESTRICTED</a><li><a href=#validator class="table-of-contents__link toc-highlight">VALIDATOR</a></ul><li><a href=#select_command class="table-of-contents__link toc-highlight">SELECT_COMMAND</a><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
259
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_DATA</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Commands my target to collect data"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ANGLE OF INSTRUMENT IN DEGREES"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.01745</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DATA COLLECTION MODE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NORMAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DIAG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NOOP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Do Nothing"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">101</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DUMMY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTINGS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Set the Settings"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5.</span><span class="token plain">times </span><span class="token keyword" style="color:rgb(127, 219, 202)">do</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain">x</span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">%></span><br></span><span class=token-line style=color:#d6deeb><span class="token string-literal string" style="color:rgb(173, 219, 103)"> APPEND_PARAMETER SETTING<%= x %></span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Setting <%= x %>"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/command.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/target><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Targets</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/telemetry><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Telemetry</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#command-concepts class="table-of-contents__link toc-highlight">Command Concepts</a><li><a href=#command-definition-files class="table-of-contents__link toc-highlight">Command Definition Files</a><li><a href=#command class="table-of-contents__link toc-highlight">COMMAND</a><li><a href=#command-modifiers class="table-of-contents__link toc-highlight">COMMAND Modifiers</a><ul><li><a href=#parameter class="table-of-contents__link toc-highlight">PARAMETER</a><li><a href=#parameter-modifiers class="table-of-contents__link toc-highlight">PARAMETER Modifiers</a><ul><li><a href=#format_string class="table-of-contents__link toc-highlight">FORMAT_STRING</a><li><a href=#units class="table-of-contents__link toc-highlight">UNITS</a><li><a href=#description class="table-of-contents__link toc-highlight">DESCRIPTION</a><li><a href=#meta class="table-of-contents__link toc-highlight">META</a><li><a href=#overlap class="table-of-contents__link toc-highlight">OVERLAP</a><li><a href=#key class="table-of-contents__link toc-highlight">KEY</a><li><a href=#variable_bit_size class="table-of-contents__link toc-highlight">VARIABLE_BIT_SIZE</a><li><a href=#required class="table-of-contents__link toc-highlight">REQUIRED</a><li><a href=#minimum_value class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a><li><a href=#maximum_value class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a><li><a href=#default_value class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a><li><a href=#state class="table-of-contents__link toc-highlight">STATE</a><li><a href=#write_conversion class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a><li><a href=#poly_write_conversion class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a><li><a href=#seg_poly_write_conversion class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a><li><a href=#generic_write_conversion_start class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a><li><a href=#generic_write_conversion_end class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a><li><a href=#overflow class="table-of-contents__link toc-highlight">OVERFLOW</a></ul><li><a href=#append_parameter class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a><li><a href=#id_parameter class="table-of-contents__link toc-highlight">ID_PARAMETER</a><li><a href=#append_id_parameter class="table-of-contents__link toc-highlight">APPEND_ID_PARAMETER</a><li><a href=#array_parameter class="table-of-contents__link toc-highlight">ARRAY_PARAMETER</a><li><a href=#append_array_parameter class="table-of-contents__link toc-highlight">APPEND_ARRAY_PARAMETER</a><li><a href=#select_parameter class="table-of-contents__link toc-highlight">SELECT_PARAMETER</a><li><a href=#delete_parameter class="table-of-contents__link toc-highlight">DELETE_PARAMETER</a><li><a href=#hidden class="table-of-contents__link toc-highlight">HIDDEN</a><li><a href=#disabled class="table-of-contents__link toc-highlight">DISABLED</a><li><a href=#disable_messages class="table-of-contents__link toc-highlight">DISABLE_MESSAGES</a><li><a href=#meta-1 class="table-of-contents__link toc-highlight">META</a><li><a href=#hazardous class="table-of-contents__link toc-highlight">HAZARDOUS</a><li><a href=#accessor class="table-of-contents__link toc-highlight">ACCESSOR</a><li><a href=#template class="table-of-contents__link toc-highlight">TEMPLATE</a><li><a href=#template_file class="table-of-contents__link toc-highlight">TEMPLATE_FILE</a><li><a href=#response class="table-of-contents__link toc-highlight">RESPONSE</a><li><a href=#error_response class="table-of-contents__link toc-highlight">ERROR_RESPONSE</a><li><a href=#related_item class="table-of-contents__link toc-highlight">RELATED_ITEM</a><li><a href=#screen class="table-of-contents__link toc-highlight">SCREEN</a><li><a href=#virtual class="table-of-contents__link toc-highlight">VIRTUAL</a><li><a href=#restricted class="table-of-contents__link toc-highlight">RESTRICTED</a><li><a href=#validator class="table-of-contents__link toc-highlight">VALIDATOR</a></ul><li><a href=#select_command class="table-of-contents__link toc-highlight">SELECT_COMMAND</a><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|