openc3-cosmos-tool-docs 6.8.1 → 6.9.1
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/README.md +5 -5
- data/Rakefile +1 -1
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/css/styles.946be27d.css +1 -0
- data/tools/staticdocs/assets/images/activity-35dc5e3ab907ff79a599ab728b7a4ace155d86835a09f0c6fa8ceebf184b7984.png +0 -0
- data/tools/staticdocs/assets/images/blank_calendar-e02977fafde5379efc62fbaf82686898bfc4745dd081d62e52e3ee94c46bff69.png +0 -0
- data/tools/staticdocs/assets/images/cmd_packets-e7906db3691ccd29600e09cf005f6f53be9d9332ba4c319a1e81e1c8c6b665ed.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-117772d4be1adbf89805f5b530da301b3dcc0d5085a552d779c9bc692bac4c44.png +0 -0
- data/tools/staticdocs/assets/images/create_activity1-5e5a8cee97e818c21e3447d96797b950fe25eb5d0e153ffc899183d28b7fd1be.png +0 -0
- data/tools/staticdocs/assets/images/create_activity2-12024f05a06874c9e7b544bac4bec1a263de1715dcb9fa2dc1aea054682e8269.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata1-70387fe6ea1aafaee24b4192e76000b31ed60d3a54f957d761cefb5d21498814.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata2-ebb8f148142b387c81df70f8a565b27942ff5f6cd5bc098a6d58a27a9b36c09e.png +0 -0
- data/tools/staticdocs/assets/images/create_note1-28feb5cf0ad0899db78059dc4ea2567dc9cb03c8c776f1c65dd959f2910481f4.png +0 -0
- data/tools/staticdocs/assets/images/create_note2-c0929ea9194606f256465cd6a6c97c60c175cf2ecbf56e6597d4886b4249fe1f.png +0 -0
- data/tools/staticdocs/assets/images/data_flows-6796d95b379f3f69e3fcf9629c68aae389f3d9a287db5b4d0bbc385d478134b4.png +0 -0
- data/tools/staticdocs/assets/images/gantt_view-3fe75622572f4a5bab2f73311127b71db5bf5aed475b90a2938c9ae61810ea54.png +0 -0
- data/tools/staticdocs/assets/images/interface_details-b71797d470007be1e0520bb5b859b4da9cd3411303388be9e6db914a99628dff.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-05db0ed276077b796b54a3bca76bd0841bfb0d700456258c878359d332ff9f8f.png +0 -0
- data/tools/staticdocs/assets/images/list_view-edfc7b6fa90e43b85dd862f06c3662dee33b3c79be923a955706001d2f07eca4.png +0 -0
- data/tools/staticdocs/assets/images/options-4cb5e315138437db9f25c87feb4be2c61738c03bc3344d46977f44a94b0af738.png +0 -0
- data/tools/staticdocs/assets/images/protocol_details-408f871b0bd8440091ac95ca76cac353bb06d0b3a6c3f756dd11e7e746d7c20c.png +0 -0
- data/tools/staticdocs/assets/images/status-9b7ac4d919d196a2bf3379d0cb262c6609fb98074c744533bb9132097cb52155.png +0 -0
- data/tools/staticdocs/assets/images/targets-b07f7cd9f19a4ca02d2838a4de58c25168f01ee256e692878e3b27b833632aca.png +0 -0
- data/tools/staticdocs/assets/images/timeline-78e3ab74af1b600eb6640831133f0240a9c20047956b18b729263988a66b8e00.png +0 -0
- data/tools/staticdocs/assets/images/tlm_packets-18345c00fd6cc01a9f7a1e363fdf8375769ba5afa4ccf22c45925184eefc57ca.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.64763f3d.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.3d58085e.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +1 -0
- data/tools/staticdocs/assets/js/{0f5d161c.0727eb1b.js → 0f5d161c.978b9fee.js} +1 -1
- data/tools/staticdocs/assets/js/0ff569c9.27128023.js +1 -0
- data/tools/staticdocs/assets/js/10209fc9.669ef887.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.1a538098.js +1 -0
- data/tools/staticdocs/assets/js/13196248.e93bfd65.js +1 -0
- data/tools/staticdocs/assets/js/{13c1b4e4.6446ccbc.js → 13c1b4e4.9735bb59.js} +1 -1
- data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +1 -0
- data/tools/staticdocs/assets/js/{1e02e6a3.a89f2446.js → 1e02e6a3.da7b7250.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.0955283c.js → 2047b354.c86efa5f.js} +1 -1
- data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.858cb22d.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +1 -0
- data/tools/staticdocs/assets/js/3326.2db66e1b.js +4 -0
- data/tools/staticdocs/assets/js/3402.80344ef5.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +1 -0
- data/tools/staticdocs/assets/js/{3dd7ef3b.f43cd057.js → 3dd7ef3b.ceb26a04.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.f6769d57.js +1 -0
- data/tools/staticdocs/assets/js/4071.821f3b2b.js +1 -0
- data/tools/staticdocs/assets/js/{411898ad.28293824.js → 411898ad.8ed3452c.js} +1 -1
- data/tools/staticdocs/assets/js/42170351.7ff72adc.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +1 -0
- data/tools/staticdocs/assets/js/5072.9a0a2752.js +1 -0
- data/tools/staticdocs/assets/js/{53ca7c5b.9468b8ed.js → 53ca7c5b.3ae5bb0f.js} +1 -1
- data/tools/staticdocs/assets/js/54d0d530.2f7aa091.js +1 -0
- data/tools/staticdocs/assets/js/5525.dd1645b0.js +101 -0
- data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.821e5ed4.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +1 -0
- data/tools/staticdocs/assets/js/6246.60dfff30.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.dc5bae56.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.d197d085.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d400f853.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.1bbde831.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.338d2338.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +1 -0
- data/tools/staticdocs/assets/js/{8434.a3e5442b.js → 9623.44668503.js} +1 -1
- data/tools/staticdocs/assets/js/{964eb012.4253acd5.js → 964eb012.c7f626c5.js} +1 -1
- data/tools/staticdocs/assets/js/97535711.a6342866.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +1 -0
- data/tools/staticdocs/assets/js/{9d6e81d0.b9f15524.js → 9d6e81d0.879c9e9e.js} +1 -1
- data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.758701f0.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.b566ee29.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.9e7f0be7.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +1 -0
- data/tools/staticdocs/assets/js/{b9f60ba6.2c4823f0.js → b9f60ba6.63638354.js} +1 -1
- data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +1 -0
- data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +1 -0
- data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.e29ff552.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.4e811739.js +1 -0
- data/tools/staticdocs/assets/js/{dc5f7beb.15b70d4b.js → dc5f7beb.c703e464.js} +1 -1
- data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.8591b830.js +1 -0
- data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +1 -0
- data/tools/staticdocs/assets/js/{fd886806.f7bfd80c.js → fd886806.fb8a587e.js} +1 -1
- data/tools/staticdocs/assets/js/main.2bcd58cc.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +46 -46
- data/tools/staticdocs/docs/configuration/command.html +97 -97
- data/tools/staticdocs/docs/configuration/conversions.html +53 -53
- data/tools/staticdocs/docs/configuration/format.html +22 -22
- data/tools/staticdocs/docs/configuration/interfaces.html +55 -55
- data/tools/staticdocs/docs/configuration/limits-response.html +10 -10
- data/tools/staticdocs/docs/configuration/plugins.html +127 -127
- data/tools/staticdocs/docs/configuration/processors.html +17 -17
- data/tools/staticdocs/docs/configuration/protocols.html +66 -66
- data/tools/staticdocs/docs/configuration/ssl-tls.html +15 -15
- data/tools/staticdocs/docs/configuration/table.html +53 -53
- data/tools/staticdocs/docs/configuration/target.html +21 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +289 -289
- data/tools/staticdocs/docs/configuration/telemetry.html +86 -86
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +14 -14
- data/tools/staticdocs/docs/development/developing.html +27 -27
- data/tools/staticdocs/docs/development/json-api.html +15 -15
- data/tools/staticdocs/docs/development/log-structure.html +13 -13
- data/tools/staticdocs/docs/development/roadmap.html +4 -4
- data/tools/staticdocs/docs/development/streaming-api.html +24 -24
- data/tools/staticdocs/docs/development/testing.html +20 -20
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/cli.html +39 -39
- data/tools/staticdocs/docs/getting-started/generators.html +25 -25
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
- data/tools/staticdocs/docs/getting-started/installation.html +23 -21
- data/tools/staticdocs/docs/getting-started/key-concepts.html +20 -20
- data/tools/staticdocs/docs/getting-started/podman.html +23 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
- data/tools/staticdocs/docs/getting-started/upgrading.html +47 -47
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +19 -12
- data/tools/staticdocs/docs/guides/cfs.html +32 -32
- data/tools/staticdocs/docs/guides/custom-widgets.html +36 -36
- data/tools/staticdocs/docs/guides/dynamic-packets.html +8 -8
- data/tools/staticdocs/docs/guides/exposing-microservices.html +11 -11
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +4 -4
- data/tools/staticdocs/docs/guides/local-mode.html +13 -13
- data/tools/staticdocs/docs/guides/logging.html +9 -9
- data/tools/staticdocs/docs/guides/monitoring.html +18 -18
- data/tools/staticdocs/docs/guides/performance.html +10 -10
- data/tools/staticdocs/docs/guides/raspberrypi.html +4 -4
- data/tools/staticdocs/docs/guides/reference-architectures.html +6 -6
- data/tools/staticdocs/docs/guides/script-writing.html +80 -80
- data/tools/staticdocs/docs/guides/scripting-api.html +715 -635
- data/tools/staticdocs/docs/guides/troubleshooting.html +8 -7
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +12 -12
- data/tools/staticdocs/docs/meta/licenses.html +9 -9
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/xtce.html +12 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/admin.html +24 -24
- data/tools/staticdocs/docs/tools/autonomic.html +19 -19
- data/tools/staticdocs/docs/tools/bucket-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/calendar.html +34 -21
- data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +31 -22
- data/tools/staticdocs/docs/tools/command-history.html +6 -6
- data/tools/staticdocs/docs/tools/command-queue.html +8 -8
- data/tools/staticdocs/docs/tools/data-extractor.html +25 -25
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +16 -16
- data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/packet-viewer.html +12 -12
- data/tools/staticdocs/docs/tools/script-runner.html +43 -43
- data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
- data/tools/staticdocs/docs/tools/table-manager.html +11 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -22
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +11 -11
- data/tools/staticdocs/img/calendar/activity.png +0 -0
- data/tools/staticdocs/img/calendar/blank_calendar.png +0 -0
- data/tools/staticdocs/img/calendar/create_activity1.png +0 -0
- data/tools/staticdocs/img/calendar/create_activity2.png +0 -0
- data/tools/staticdocs/img/calendar/create_metadata1.png +0 -0
- data/tools/staticdocs/img/calendar/create_metadata2.png +0 -0
- data/tools/staticdocs/img/calendar/create_note1.png +0 -0
- data/tools/staticdocs/img/calendar/create_note2.png +0 -0
- data/tools/staticdocs/img/calendar/gantt_view.png +0 -0
- data/tools/staticdocs/img/calendar/list_view.png +0 -0
- data/tools/staticdocs/img/calendar/options.png +0 -0
- data/tools/staticdocs/img/calendar/timeline.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_packets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/data_flows.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/interface_details.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/interfaces.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/protocol_details.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/routers.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/status.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/targets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/tlm_packets.png +0 -0
- data/tools/staticdocs/index.html +2 -2
- data/tools/staticdocs/lunr-index-1759687174225.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1759687174225.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +120 -107
- data/tools/staticdocs/assets/css/styles.0edf3032.css +0 -1
- data/tools/staticdocs/assets/images/blank_calendar-70e605942120937b862bd7039348229bab9af1f9c93d356ddbf401a3e8543c74.png +0 -0
- data/tools/staticdocs/assets/images/calendar-dacbcbb05175c76f3406b4aaade0465444c20b72e93366c79fed1f6eec018c42.png +0 -0
- data/tools/staticdocs/assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
- data/tools/staticdocs/assets/images/create_activity1-c05ffc03af2df852aeb3ad246f53f259af504e0e6c64cdac21f9126947c49f95.png +0 -0
- data/tools/staticdocs/assets/images/create_activity2-58c7da6f79dd510701148c0c54fae02c830b9ca4af662a7b132987ed3410a8f7.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata1-a331ba8f0bd19bf5f8d7f2e083c3c7164e9b7b9936f5a7f83c4141c62a6c46f6.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata2-c57b5420d5469b48289030ed7c64758539c2319dc742159caa0d4c8fe35050a8.png +0 -0
- data/tools/staticdocs/assets/images/create_note1-472b93e8e0e3e66a2e6198e0d4573cdc38cc356df87be66163f990f18137f6c0.png +0 -0
- data/tools/staticdocs/assets/images/create_note2-770501a149ef4aabae24d0b636f46ed61fbdcfda9537c61637c07c60257e9228.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png +0 -0
- data/tools/staticdocs/assets/images/list_view-2f36ce06962e67d5a4f1f060956e5089b3f13c8ab57f33103c3781687611e7a9.png +0 -0
- data/tools/staticdocs/assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png +0 -0
- data/tools/staticdocs/assets/images/targets-6b17daf175185b13bea9eddafd4773e5f41d1ef4e953134f30bee0799c1e5c31.png +0 -0
- data/tools/staticdocs/assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5366d64b.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.eb311155.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.974abc47.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +0 -1
- data/tools/staticdocs/assets/js/10209fc9.ae369363.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.32c30401.js +0 -1
- data/tools/staticdocs/assets/js/1085.d1eba438.js +0 -1
- data/tools/staticdocs/assets/js/1319.d9ec0592.js +0 -101
- data/tools/staticdocs/assets/js/13196248.9e1ebaa5.js +0 -1
- data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.81906212.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.db29df30.js +0 -1
- data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.35825078.js +0 -1
- data/tools/staticdocs/assets/js/5074.653f3924.js +0 -1
- data/tools/staticdocs/assets/js/5410.60ab1dba.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +0 -1
- data/tools/staticdocs/assets/js/59ed27a4.8eb3444b.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +0 -1
- data/tools/staticdocs/assets/js/6242.bdac32c1.js +0 -4
- data/tools/staticdocs/assets/js/6831b732.7cf97282.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.b96d263c.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +0 -1
- data/tools/staticdocs/assets/js/8851.4837d29a.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +0 -1
- data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +0 -1
- data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.791cdc39.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.2695e35a.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.71b17b00.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.c8eb51b6.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.e240f32e.js +0 -1
- data/tools/staticdocs/assets/js/b38a6d74.7363be85.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.2a473696.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.482b8f7b.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +0 -1
- data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +0 -1
- data/tools/staticdocs/assets/js/f75a5f33.4d2501bc.js +0 -1
- data/tools/staticdocs/assets/js/main.994f9f74.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.44311138.js +0 -1
- data/tools/staticdocs/lunr-index-1757781681330.json +0 -1
- data/tools/staticdocs/search-doc-1757781681330.json +0 -1
|
@@ -1,92 +1,92 @@
|
|
|
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.
|
|
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><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><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.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
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
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/processors>Processors</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/limits-response>Limits Response</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>
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),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_TKVD 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_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></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_YWZZ><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_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><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><span title=Introduction class=linkLabel_THKR>Introduction</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></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="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></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><span title="File Format" class=linkLabel_THKR>File Format</span></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><span title=Plugins class=linkLabel_THKR>Plugins</span></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><span title=Targets class=linkLabel_THKR>Targets</span></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><span title=Commands class=linkLabel_THKR>Commands</span></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><span title=Telemetry class=linkLabel_THKR>Telemetry</span></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><span title=Interfaces class=linkLabel_THKR>Interfaces</span></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><span title=Protocols class=linkLabel_THKR>Protocols</span></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><span title=Accessors class=linkLabel_THKR>Accessors</span></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><span title=Conversions class=linkLabel_THKR>Conversions</span></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/processors><span title=Processors class=linkLabel_THKR>Processors</span></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/limits-response><span title="Limits Response" class=linkLabel_THKR>Limits Response</span></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><span title=Tables class=linkLabel_THKR>Tables</span></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><span title=Screens class=linkLabel_THKR>Screens</span></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><span title=SSL-TLS class=linkLabel_THKR>SSL-TLS</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></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><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" 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_u_XA><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_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Commands</h1></header><h2 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h2>
|
|
5
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=
|
|
7
|
-
<h2 class="anchor
|
|
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_m1Wr /></p>
|
|
7
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h2>
|
|
8
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>
|
|
9
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>
|
|
10
10
|
<div style=clear:both></div>
|
|
11
|
-
<h2 class="anchor
|
|
11
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=command-authority-enterprise>Command Authority (Enterprise)<a href=#command-authority-enterprise class=hash-link aria-label="Direct link to Command Authority (Enterprise)" title="Direct link to Command Authority (Enterprise)" translate=no></a></h2>
|
|
12
12
|
<p>Command Authority can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Once Command Authority is enabled, individual users can take and release Command Authority which enables exclusive command and script access to that target for that user. Without taking Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority.</p>
|
|
13
|
-
<p><img decoding=async loading=lazy alt="Command Authority" src=/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png width=2788 height=1282 class=
|
|
14
|
-
<img decoding=async loading=lazy alt="Command Authority in CmdTlm Server" src=/tools/staticdocs/assets/images/targets-
|
|
15
|
-
<h2 class="anchor
|
|
13
|
+
<p><img decoding=async loading=lazy alt="Command Authority" src=/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png width=2788 height=1282 class=img_m1Wr />
|
|
14
|
+
<img decoding=async loading=lazy alt="Command Authority in CmdTlm Server" src=/tools/staticdocs/assets/images/targets-b07f7cd9f19a4ca02d2838a4de58c25168f01ee256e692878e3b27b833632aca.png width=2878 height=1098 class=img_m1Wr /></p>
|
|
15
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=critical-commanding-enterprise>Critical Commanding (Enterprise)<a href=#critical-commanding-enterprise class=hash-link aria-label="Direct link to Critical Commanding (Enterprise)" title="Direct link to Critical Commanding (Enterprise)" translate=no></a></h2>
|
|
16
16
|
<p>Critical Commanding can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Critical commanding requires a different user to approve critical commands. When Critical Commanding mode is set to NORMAL, HAZARDOUS and RESTRICTED commands need approval. When Critical Commanding mode is set to ALL, all manual commands will require approval. OFF is the default, and disables Critical Commanding.</p>
|
|
17
17
|
<p>Here is an example of sending a HAZARDOUS command in Command Sender when Critical Command Mode is set to NORMAL.</p>
|
|
18
|
-
<p><img decoding=async loading=lazy alt="Critical Command" src=/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png width=2288 height=758 class=
|
|
18
|
+
<p><img decoding=async loading=lazy alt="Critical Command" src=/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png width=2288 height=758 class=img_m1Wr /></p>
|
|
19
19
|
<h1>Command Keywords</h1>
|
|
20
|
-
<h2 class="anchor
|
|
20
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=command>COMMAND<a href=#command class=hash-link aria-label="Direct link to COMMAND" title="Direct link to COMMAND" translate=no></a></h2>
|
|
21
21
|
<p><strong>Defines a new command packet</strong></p>
|
|
22
|
-
<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
|
|
22
|
+
<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>
|
|
23
23
|
<p>Example Usage:</p>
|
|
24
|
-
<div class="language-ruby
|
|
25
|
-
<h2 class="anchor
|
|
24
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
25
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h2>
|
|
26
26
|
<p>The following keywords must follow a COMMAND keyword.</p>
|
|
27
|
-
<h3 class="anchor
|
|
27
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=parameter>PARAMETER<a href=#parameter class=hash-link aria-label="Direct link to PARAMETER" title="Direct link to PARAMETER" translate=no></a></h3>
|
|
28
28
|
<p><strong>Defines a command parameter in the current command packet</strong></p>
|
|
29
|
-
<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 an offset from the end of the packet. Always use a bit offset of 0 for derived parameters.<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
|
|
29
|
+
<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 an offset from the end of the packet. Always use a bit offset of 0 for derived parameters.<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>
|
|
30
30
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
31
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
31
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
32
32
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
33
|
-
<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
|
|
33
|
+
<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>
|
|
34
34
|
<p>Example Usage:</p>
|
|
35
|
-
<div class="language-ruby
|
|
36
|
-
<h3 class="anchor
|
|
35
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
36
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
37
37
|
<p>The following keywords must follow a PARAMETER keyword.</p>
|
|
38
|
-
<h4 class="anchor
|
|
38
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
39
39
|
<p><strong>Adds printf style formatting</strong></p>
|
|
40
40
|
<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>
|
|
41
41
|
<p>Example Usage:</p>
|
|
42
|
-
<div class="language-ruby
|
|
43
|
-
<h4 class="anchor
|
|
42
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
43
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=units>UNITS<a href=#units class=hash-link aria-label="Direct link to UNITS" title="Direct link to UNITS" translate=no></a></h4>
|
|
44
44
|
<p><strong>Add displayed units</strong></p>
|
|
45
45
|
<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>
|
|
46
46
|
<p>Example Usage:</p>
|
|
47
|
-
<div class="language-ruby
|
|
48
|
-
<h4 class="anchor
|
|
47
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
48
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=description>DESCRIPTION<a href=#description class=hash-link aria-label="Direct link to DESCRIPTION" title="Direct link to DESCRIPTION" translate=no></a></h4>
|
|
49
49
|
<p><strong>Override the defined description</strong></p>
|
|
50
50
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new description<td>True</table>
|
|
51
|
-
<h4 class="anchor
|
|
51
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=meta>META<a href=#meta class=hash-link aria-label="Direct link to META" title="Direct link to META" translate=no></a></h4>
|
|
52
52
|
<p><strong>Stores custom user metadata</strong></p>
|
|
53
53
|
<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>
|
|
54
54
|
<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>
|
|
55
55
|
<p>Example Usage:</p>
|
|
56
|
-
<div class="language-ruby
|
|
57
|
-
<h4 class="anchor
|
|
56
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
57
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=overlap>OVERLAP<a href=#overlap class=hash-link aria-label="Direct link to OVERLAP" title="Direct link to OVERLAP" translate=no></a></h4>
|
|
58
58
|
<p><div class=right>(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
|
59
59
|
<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>
|
|
60
|
-
<h4 class="anchor
|
|
60
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=key>KEY<a href=#key class=hash-link aria-label="Direct link to KEY" title="Direct link to KEY" translate=no></a></h4>
|
|
61
61
|
<p><div class=right>(Since 5.0.10)</div><strong>Defines the key used to access this raw value in the packet.</strong><p></p>
|
|
62
62
|
<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>
|
|
63
63
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key string<td>The key to access this item<td>True</table>
|
|
64
64
|
<p>Example Usage:</p>
|
|
65
|
-
<div class="language-ruby
|
|
66
|
-
<h4 class="anchor
|
|
65
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
66
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
67
67
|
<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>
|
|
68
68
|
<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
|
-
<h4 class="anchor
|
|
69
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=obfuscate>OBFUSCATE<a href=#obfuscate class=hash-link aria-label="Direct link to OBFUSCATE" title="Direct link to OBFUSCATE" translate=no></a></h4>
|
|
70
70
|
<p><div class=right>(Since 6.6.0)</div><strong>Hides the item value in the UI, text logs, and raw binary file</strong><p></p>
|
|
71
|
-
<h4 class="anchor
|
|
71
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=required>REQUIRED<a href=#required class=hash-link aria-label="Direct link to REQUIRED" title="Direct link to REQUIRED" translate=no></a></h4>
|
|
72
72
|
<p><strong>Parameter is required to be populated in scripts</strong></p>
|
|
73
73
|
<p>When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition.</p>
|
|
74
|
-
<h4 class="anchor
|
|
74
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=minimum_value>MINIMUM_VALUE<a href=#minimum_value class=hash-link aria-label="Direct link to MINIMUM_VALUE" title="Direct link to MINIMUM_VALUE" translate=no></a></h4>
|
|
75
75
|
<p><strong>Override the defined minimum value</strong></p>
|
|
76
76
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new minimum value for the parameter<td>True</table>
|
|
77
|
-
<h4 class="anchor
|
|
77
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=maximum_value>MAXIMUM_VALUE<a href=#maximum_value class=hash-link aria-label="Direct link to MAXIMUM_VALUE" title="Direct link to MAXIMUM_VALUE" translate=no></a></h4>
|
|
78
78
|
<p><strong>Override the defined maximum value</strong></p>
|
|
79
79
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new maximum value for the parameter<td>True</table>
|
|
80
|
-
<h4 class="anchor
|
|
80
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=default_value>DEFAULT_VALUE<a href=#default_value class=hash-link aria-label="Direct link to DEFAULT_VALUE" title="Direct link to DEFAULT_VALUE" translate=no></a></h4>
|
|
81
81
|
<p><strong>Override the defined default value</strong></p>
|
|
82
82
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new default value for the parameter<td>True</table>
|
|
83
|
-
<h4 class="anchor
|
|
83
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=state>STATE<a href=#state class=hash-link aria-label="Direct link to STATE" title="Direct link to STATE" translate=no></a></h4>
|
|
84
84
|
<p><strong>Defines a key/value pair for the current command parameter</strong></p>
|
|
85
85
|
<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>
|
|
86
|
-
<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
|
|
86
|
+
<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>
|
|
87
87
|
<p>Example Usage:</p>
|
|
88
|
-
<div class="language-ruby
|
|
89
|
-
<h4 class="anchor
|
|
88
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
89
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
90
90
|
<p><strong>Applies a conversion when writing the current command parameter</strong></p>
|
|
91
91
|
<p>Conversions are implemented in a custom Ruby or Python file which should be
|
|
92
92
|
located in the target's lib folder. The class must inherit from Conversion.
|
|
@@ -104,21 +104,21 @@ and should be specified as a string. For a full example see the IP_ADDRESS param
|
|
|
104
104
|
in the TIME_OFFSET command definition of the COSMOS Demo
|
|
105
105
|
<a href=https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt target=_blank rel="noopener noreferrer">INST inst_cmds.txt</a>
|
|
106
106
|
or <a href=https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt target=_blank rel="noopener noreferrer">INST2 inst_cmds.txt</a>.</p>
|
|
107
|
-
<div class="theme-admonition theme-admonition-info
|
|
107
|
+
<div class="theme-admonition theme-admonition-info admonition_AUqJ alert alert--info"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_ISwi><p>When a command is built, each item gets written (and write conversions are run)
|
|
108
108
|
to set the default value. Then items are written (again write conversions are run)
|
|
109
109
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
110
110
|
no guarantees which parameters have already been written. The packet itself has a
|
|
111
111
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
112
112
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
113
113
|
<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>
|
|
114
|
-
<div class="tabs-container
|
|
115
|
-
<h4 class="anchor
|
|
114
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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></div><div role=tabpanel class=tabItem_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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></div></div></div>
|
|
115
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
116
116
|
<p><strong>Adds a polynomial conversion factor to the current command parameter</strong></p>
|
|
117
117
|
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#polynomial_conversion>Polynomial Conversion</a> for more information.</p>
|
|
118
|
-
<h4 class="anchor
|
|
118
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
119
119
|
<p><strong>Adds a segmented polynomial conversion factor to the current command parameter</strong></p>
|
|
120
120
|
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#segmented_polynomial_conversion>Segmented Polynomial Conversion</a> for more information.</p>
|
|
121
|
-
<h4 class="anchor
|
|
121
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
122
122
|
<p><strong>Start a generic write conversion</strong></p>
|
|
123
123
|
<p>Adds a generic conversion function to the current command parameter.
|
|
124
124
|
This conversion factor is applied to the value entered by the user before it
|
|
@@ -129,132 +129,132 @@ class (Note, referencing the packet as 'myself' is still supported for backwards
|
|
|
129
129
|
compatibility). The last line of code should return the converted
|
|
130
130
|
value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
|
|
131
131
|
code for the conversion have been given.</p>
|
|
132
|
-
<div class="theme-admonition theme-admonition-info
|
|
132
|
+
<div class="theme-admonition theme-admonition-info admonition_AUqJ alert alert--info"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_ISwi><p>When a command is built, each item gets written (and write conversions are run)
|
|
133
133
|
to set the default value. Then items are written (again write conversions are run)
|
|
134
134
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
135
135
|
no guarantees which parameters have already been written. The packet itself has a
|
|
136
136
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
137
137
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
138
|
-
<div class="theme-admonition theme-admonition-warning
|
|
139
|
-
<div class="tabs-container
|
|
140
|
-
<h4 class="anchor
|
|
138
|
+
<div class="theme-admonition theme-admonition-warning admonition_AUqJ alert alert--warning"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><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_ISwi><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>
|
|
139
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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></div><div role=tabpanel class=tabItem_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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></div></div></div>
|
|
140
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h4>
|
|
141
141
|
<p><strong>Complete a generic write conversion</strong></p>
|
|
142
|
-
<h4 class="anchor
|
|
142
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=overflow>OVERFLOW<a href=#overflow class=hash-link aria-label="Direct link to OVERFLOW" title="Direct link to OVERFLOW" translate=no></a></h4>
|
|
143
143
|
<p><strong>Set the behavior when writing a value overflows the type</strong></p>
|
|
144
144
|
<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>
|
|
145
|
-
<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
|
|
145
|
+
<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>
|
|
146
146
|
<p>Example Usage:</p>
|
|
147
|
-
<div class="language-ruby
|
|
148
|
-
<h3 class="anchor
|
|
147
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
148
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
149
149
|
<p><strong>Defines a command parameter in the current command packet</strong></p>
|
|
150
|
-
<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
|
|
150
|
+
<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>
|
|
151
151
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
152
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
152
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
153
153
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
154
|
-
<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
|
|
154
|
+
<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>
|
|
155
155
|
<p>Example Usage:</p>
|
|
156
|
-
<div class="language-ruby
|
|
157
|
-
<h3 class="anchor
|
|
156
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
157
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
158
158
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
|
159
159
|
<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>
|
|
160
|
-
<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 an offset from the end of the packet.<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
|
|
160
|
+
<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 an offset from the end of the packet.<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>
|
|
161
161
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
162
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>ID Value<td>Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet.<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
162
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>ID Value<td>Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet.<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
163
163
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
164
|
-
<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
|
|
164
|
+
<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>
|
|
165
165
|
<p>Example Usage:</p>
|
|
166
|
-
<div class="language-ruby
|
|
167
|
-
<h3 class="anchor
|
|
166
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
167
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
168
168
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
|
169
169
|
<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>
|
|
170
|
-
<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
|
|
170
|
+
<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>
|
|
171
171
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
172
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>ID Value<td>Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet.<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
172
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>ID Value<td>Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet.<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. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
173
173
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
174
|
-
<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
|
|
174
|
+
<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>
|
|
175
175
|
<p>Example Usage:</p>
|
|
176
|
-
<div class="language-ruby
|
|
177
|
-
<h3 class="anchor
|
|
176
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
177
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
178
178
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
|
179
|
-
<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 an 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
|
|
179
|
+
<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 an 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>
|
|
180
180
|
<p>Example Usage:</p>
|
|
181
|
-
<div class="language-ruby
|
|
182
|
-
<h3 class="anchor
|
|
181
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
182
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
183
183
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
|
184
|
-
<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
|
|
184
|
+
<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>
|
|
185
185
|
<p>Example Usage:</p>
|
|
186
|
-
<div class="language-ruby
|
|
187
|
-
<h3 class="anchor
|
|
186
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
187
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
188
188
|
<p><strong>Selects an existing command parameter for editing</strong></p>
|
|
189
189
|
<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>
|
|
190
190
|
<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>
|
|
191
191
|
<p>Example Usage:</p>
|
|
192
|
-
<div class="language-ruby
|
|
193
|
-
<h3 class="anchor
|
|
192
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
193
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h3>
|
|
194
194
|
<p><div class=right>(Since 4.4.1)</div><strong>Deletes an existing command parameter from the packet definition</strong><p></p>
|
|
195
195
|
<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>
|
|
196
196
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Parameter<td>Name of the parameter to delete<td>True</table>
|
|
197
197
|
<p>Example Usage:</p>
|
|
198
|
-
<div class="language-ruby
|
|
199
|
-
<h3 class="anchor
|
|
198
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
199
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=hidden>HIDDEN<a href=#hidden class=hash-link aria-label="Direct link to HIDDEN" title="Direct link to HIDDEN" translate=no></a></h3>
|
|
200
200
|
<p><strong>Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator</strong></p>
|
|
201
201
|
<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>
|
|
202
|
-
<h3 class="anchor
|
|
202
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=disabled>DISABLED<a href=#disabled class=hash-link aria-label="Direct link to DISABLED" title="Direct link to DISABLED" translate=no></a></h3>
|
|
203
203
|
<p><strong>Disables this command from being sent</strong></p>
|
|
204
204
|
<p>Hides the command and also disables it from being sent by scripts. Attempts to send DISABLED commands result in an error message.</p>
|
|
205
|
-
<h3 class="anchor
|
|
205
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=disable_messages>DISABLE_MESSAGES<a href=#disable_messages class=hash-link aria-label="Direct link to DISABLE_MESSAGES" title="Direct link to DISABLE_MESSAGES" translate=no></a></h3>
|
|
206
206
|
<p><strong>Disable the Server from printing cmd(...) messages. Commands are still logged.</strong></p>
|
|
207
|
-
<h3 class="anchor
|
|
207
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=meta-1>META<a href=#meta-1 class=hash-link aria-label="Direct link to META" title="Direct link to META" translate=no></a></h3>
|
|
208
208
|
<p><strong>Stores metadata for the current command</strong></p>
|
|
209
209
|
<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>
|
|
210
210
|
<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>
|
|
211
211
|
<p>Example Usage:</p>
|
|
212
|
-
<div class="language-ruby
|
|
213
|
-
<h3 class="anchor
|
|
212
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
213
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=hazardous>HAZARDOUS<a href=#hazardous class=hash-link aria-label="Direct link to HAZARDOUS" title="Direct link to HAZARDOUS" translate=no></a></h3>
|
|
214
214
|
<p><strong>Designates the current command as hazardous</strong></p>
|
|
215
215
|
<p>Sending a hazardous command causes a dialog asking for confirmation before sending the command</p>
|
|
216
216
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Description<td>Description for why the command is hazardous which must be enclosed with quotes<td>False</table>
|
|
217
|
-
<h3 class="anchor
|
|
217
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=accessor>ACCESSOR<a href=#accessor class=hash-link aria-label="Direct link to ACCESSOR" title="Direct link to ACCESSOR" translate=no></a></h3>
|
|
218
218
|
<p><div class=right>(Since 5.0.10)</div><strong>Defines the class used to read and write raw values from the packet</strong><p></p>
|
|
219
219
|
<p>Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. For more information see <a href=/tools/staticdocs/docs/configuration/accessors>Accessors</a>.</p>
|
|
220
220
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Accessor Class Name<td>The name of the accessor class<td>True<tr><td>Argument<td>Additional argument passed to the accessor class constructor<td>False</table>
|
|
221
|
-
<h3 class="anchor
|
|
221
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=template>TEMPLATE<a href=#template class=hash-link aria-label="Direct link to TEMPLATE" title="Direct link to TEMPLATE" translate=no></a></h3>
|
|
222
222
|
<p><div class=right>(Since 5.0.10)</div><strong>Defines a template string used to initialize the command before default values are filled in</strong><p></p>
|
|
223
223
|
<p>Generally the template string is formatted in JSON or HTML and then values are filled in with command parameters. Must be UTF-8 encoded.</p>
|
|
224
224
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Template<td>The template string which should be enclosed in quotes<td>True</table>
|
|
225
|
-
<h3 class="anchor
|
|
225
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=template_file>TEMPLATE_FILE<a href=#template_file class=hash-link aria-label="Direct link to TEMPLATE_FILE" title="Direct link to TEMPLATE_FILE" translate=no></a></h3>
|
|
226
226
|
<p><div class=right>(Since 5.0.10)</div><strong>Defines a template file used to initialize the command before default values are filled in</strong><p></p>
|
|
227
227
|
<p>Generally the template file is formatted in JSON or HTML and then values are filled in with command parameters. Can be binary or UTF-8.</p>
|
|
228
228
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Template File Path<td>The relative path to the template file. Filename should generally start with an underscore.<td>True</table>
|
|
229
|
-
<h3 class="anchor
|
|
229
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=response>RESPONSE<a href=#response class=hash-link aria-label="Direct link to RESPONSE" title="Direct link to RESPONSE" translate=no></a></h3>
|
|
230
230
|
<p><div class=right>(Since 5.14.0)</div><strong>Indicates the expected telemetry packet response to this command</strong><p></p>
|
|
231
231
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target Name of telemetry response packet<td>True<tr><td>Packet Name<td>Packet Name of telemetry response packet<td>True</table>
|
|
232
|
-
<h3 class="anchor
|
|
232
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=error_response>ERROR_RESPONSE<a href=#error_response class=hash-link aria-label="Direct link to ERROR_RESPONSE" title="Direct link to ERROR_RESPONSE" translate=no></a></h3>
|
|
233
233
|
<p><div class=right>(Since 5.14.0)</div><strong>Indicates the expected telemetry packet error response to this command</strong><p></p>
|
|
234
234
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target Name of telemetry error response packet<td>True<tr><td>Packet Name<td>Packet Name of telemetry error response packet<td>True</table>
|
|
235
|
-
<h3 class="anchor
|
|
235
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=related_item>RELATED_ITEM<a href=#related_item class=hash-link aria-label="Direct link to RELATED_ITEM" title="Direct link to RELATED_ITEM" translate=no></a></h3>
|
|
236
236
|
<p><div class=right>(Since 5.14.0)</div><strong>Defines a related telemetry item to this command</strong><p></p>
|
|
237
237
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target Name of related telemetry item<td>True<tr><td>Packet Name<td>Packet Name of related telemetry item<td>True<tr><td>Item Name<td>Item Name of related telemetry item<td>True</table>
|
|
238
|
-
<h3 class="anchor
|
|
238
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=screen>SCREEN<a href=#screen class=hash-link aria-label="Direct link to SCREEN" title="Direct link to SCREEN" translate=no></a></h3>
|
|
239
239
|
<p><div class=right>(Since 5.14.0)</div><strong>Defines a related telemetry screen to this command</strong><p></p>
|
|
240
240
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target Name of related telemetry screen<td>True<tr><td>Screen Name<td>Screen Name of related telemetry screen<td>True</table>
|
|
241
|
-
<h3 class="anchor
|
|
241
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=virtual>VIRTUAL<a href=#virtual class=hash-link aria-label="Direct link to VIRTUAL" title="Direct link to VIRTUAL" translate=no></a></h3>
|
|
242
242
|
<p><div class=right>(Since 5.18.0)</div><strong>Marks this packet as virtual and not participating in identification</strong><p></p>
|
|
243
243
|
<p>Used for packet definitions that can be used as structures for items with a given packet.</p>
|
|
244
|
-
<h3 class="anchor
|
|
244
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=restricted>RESTRICTED<a href=#restricted class=hash-link aria-label="Direct link to RESTRICTED" title="Direct link to RESTRICTED" translate=no></a></h3>
|
|
245
245
|
<p><div class=right>(Since 5.20.0)</div><strong>Marks this packet as restricted and will require approval if critical commanding is enabled</strong><p></p>
|
|
246
246
|
<p>Used as one of the two types of critical commands (HAZARDOUS and RESTRICTED)</p>
|
|
247
|
-
<h3 class="anchor
|
|
247
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=validator>VALIDATOR<a href=#validator class=hash-link aria-label="Direct link to VALIDATOR" title="Direct link to VALIDATOR" translate=no></a></h3>
|
|
248
248
|
<p><div class=right>(Since 5.19.0)</div><strong>Defines a validator class for a command</strong><p></p>
|
|
249
249
|
<p>Validator class is used to validate the command success or failure with both a pre_check and post_check method.</p>
|
|
250
250
|
<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>
|
|
251
|
-
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><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></div><div role=tabpanel class=tabItem_OMyP hidden><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></div></div></div>
|
|
252
|
-
<h2 class="anchor
|
|
251
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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">py</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Return true to indicate Success, false to indicate Failure,</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"># and nil to indicate Unknown. The second value is the optional message.</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Return true to indicate Success, false to indicate Failure,</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"># and nil to indicate Unknown. The second value is the optional message.</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></div><div role=tabpanel class=tabItem_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Return true to indicate Success, false to indicate Failure,</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"># and nil to indicate Unknown. The second value is the optional message.</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Return true to indicate Success, false to indicate Failure,</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"># and nil to indicate Unknown. The second value is the optional message.</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></div></div></div>
|
|
252
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h2>
|
|
253
253
|
<p><strong>Selects an existing command packet for editing</strong></p>
|
|
254
254
|
<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>
|
|
255
255
|
<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>
|
|
256
256
|
<p>Example Usage:</p>
|
|
257
|
-
<div class="language-ruby
|
|
258
|
-
<h2 class="anchor
|
|
257
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
258
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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" translate=no></a></h2>
|
|
259
259
|
<p><strong>Example File: TARGET/cmd_tlm/cmd.txt</strong></p>
|
|
260
|
-
<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-authority-enterprise class="table-of-contents__link toc-highlight">Command Authority (Enterprise)</a><li><a href=#critical-commanding-enterprise class="table-of-contents__link toc-highlight">Critical Commanding (Enterprise)</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=#obfuscate class="table-of-contents__link toc-highlight">OBFUSCATE</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>
|
|
260
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_CuGa 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_h4bd"></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_rhgf 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-authority-enterprise class="table-of-contents__link toc-highlight">Command Authority (Enterprise)</a><li><a href=#critical-commanding-enterprise class="table-of-contents__link toc-highlight">Critical Commanding (Enterprise)</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=#obfuscate class="table-of-contents__link toc-highlight">OBFUSCATE</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-label="(opens in new tab)" class=iconExternalLink_mMqu><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-label="(opens in new tab)" class=iconExternalLink_mMqu><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></body>
|