openc3-cosmos-tool-docs 5.14.2 → 5.15.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/js/019369f3.3a124fd7.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.c85ad785.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.4d6b8154.js +1 -0
- data/tools/staticdocs/assets/js/{07876b9c.bcadf7df.js → 07876b9c.b8d12431.js} +1 -1
- data/tools/staticdocs/assets/js/078dbab0.45ea4593.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.dda04dbb.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.317b47d0.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.a946540f.js +1 -0
- data/tools/staticdocs/assets/js/13196248.d8f8ef9f.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.50ee3d02.js +1 -0
- data/tools/staticdocs/assets/js/1b2b4b61.2556cd65.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.75fe47dd.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.77516494.js +1 -0
- data/tools/staticdocs/assets/js/2601.ca992ab9.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +1 -0
- data/tools/staticdocs/assets/js/{2923e883.779dc8d3.js → 2923e883.ed90d0a7.js} +1 -1
- data/tools/staticdocs/assets/js/2bb7bf90.c642620c.js +1 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.f84c6956.js +1 -0
- data/tools/staticdocs/assets/js/{3df159b4.edd6dd5f.js → 3df159b4.ff98bfab.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.c318f801.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e29e2db3.js +1 -0
- data/tools/staticdocs/assets/js/42170351.15f2f1e3.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.4e7d6a97.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.3f1245d5.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.769f5473.js +1 -0
- data/tools/staticdocs/assets/js/{55cdbca5.e73bdb1a.js → 55cdbca5.695875ea.js} +1 -1
- data/tools/staticdocs/assets/js/5723.f6123e37.js +1 -0
- data/tools/staticdocs/assets/js/{9142.cab356f2.js → 5778.7d36f1c2.js} +1 -1
- data/tools/staticdocs/assets/js/5b233ba7.0029b2f5.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.84f6ce9e.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.8667906a.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.91d6735f.js +1 -0
- data/tools/staticdocs/assets/js/{5fe211ef.debbddaa.js → 5fe211ef.1d991947.js} +1 -1
- data/tools/staticdocs/assets/js/{64630c4f.81b3c47d.js → 64630c4f.a229ae1d.js} +1 -1
- data/tools/staticdocs/assets/js/6831b732.a77e4761.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.2700ad91.js +1 -0
- data/tools/staticdocs/assets/js/{6b210247.b50441ee.js → 6b210247.074332a1.js} +1 -1
- data/tools/staticdocs/assets/js/6b65133b.109a6bef.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.67f5a7a4.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.5fca8d68.js +1 -0
- data/tools/staticdocs/assets/js/{75373ac0.f35aa5aa.js → 75373ac0.6a0a4fa2.js} +1 -1
- data/tools/staticdocs/assets/js/{75e64983.9153c043.js → 75e64983.e31793e1.js} +1 -1
- data/tools/staticdocs/assets/js/7760.7f593c4f.js +2 -0
- data/tools/staticdocs/assets/js/7918.25ec42db.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.a8f59357.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.de702714.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.0f25fdc3.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.66b19930.js +1 -0
- data/tools/staticdocs/assets/js/{97535711.14f1644d.js → 97535711.ddc0f5af.js} +1 -1
- data/tools/staticdocs/assets/js/{99581c43.de6d7078.js → 99581c43.0767018a.js} +1 -1
- data/tools/staticdocs/assets/js/99b59eea.d4dd9989.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.30085d79.js +1 -0
- data/tools/staticdocs/assets/js/a507c363.198e9246.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.48b6c791.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.cfb3492e.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.6281c551.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.b4c6c1b8.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.66d95cb7.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.655a4097.js +1 -0
- data/tools/staticdocs/assets/js/{bd0034eb.ca5c64eb.js → bd0034eb.ff7f6265.js} +1 -1
- data/tools/staticdocs/assets/js/c24eae19.98857ebf.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.f669adda.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.6ee752c7.js +1 -0
- data/tools/staticdocs/assets/js/{d1b923aa.c606e06a.js → d1b923aa.e7ee188a.js} +1 -1
- data/tools/staticdocs/assets/js/d1bfc316.963c2477.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.31d82456.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.905988ec.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.80e1a28b.js +1 -0
- data/tools/staticdocs/assets/js/{d797a795.b35ee94f.js → d797a795.5725bf2b.js} +1 -1
- data/tools/staticdocs/assets/js/d8ca4191.56c22a69.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.16d983a0.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.c35b153c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.88b0f00b.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.3aa571ae.js +1 -0
- data/tools/staticdocs/assets/js/ebec1ccb.a801549e.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.0b19ae07.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.57eeb84b.js +1 -0
- data/tools/staticdocs/assets/js/main.abd362be.js +2 -0
- data/tools/staticdocs/assets/js/runtime~main.7575b058.js +1 -0
- data/tools/staticdocs/docs/configuration/command.html +168 -74
- data/tools/staticdocs/docs/configuration/format.html +51 -22
- data/tools/staticdocs/docs/configuration/interfaces.html +78 -23
- data/tools/staticdocs/docs/configuration/plugins.html +162 -113
- data/tools/staticdocs/docs/configuration/protocols.html +86 -46
- data/tools/staticdocs/docs/configuration/ssl-tls.html +102 -31
- data/tools/staticdocs/docs/configuration/table.html +113 -48
- data/tools/staticdocs/docs/configuration/target.html +29 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +441 -183
- data/tools/staticdocs/docs/configuration/telemetry.html +175 -75
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +54 -11
- data/tools/staticdocs/docs/development/developing.html +79 -28
- data/tools/staticdocs/docs/development/host-install.html +20 -7
- data/tools/staticdocs/docs/development/json-api.html +30 -18
- data/tools/staticdocs/docs/development/log-structure.html +11 -11
- data/tools/staticdocs/docs/development/roadmap.html +11 -11
- data/tools/staticdocs/docs/development/streaming-api.html +81 -9
- data/tools/staticdocs/docs/development/testing.html +23 -14
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/generators.html +107 -33
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +70 -22
- data/tools/staticdocs/docs/getting-started/installation.html +33 -22
- data/tools/staticdocs/docs/getting-started/key_concepts.html +33 -33
- data/tools/staticdocs/docs/getting-started/podman.html +54 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +18 -18
- data/tools/staticdocs/docs/getting-started/upgrading.html +14 -9
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +61 -17
- data/tools/staticdocs/docs/guides/cfs.html +182 -42
- data/tools/staticdocs/docs/guides/custom-widgets.html +44 -17
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +12 -3
- data/tools/staticdocs/docs/guides/local-mode.html +18 -13
- data/tools/staticdocs/docs/guides/logging.html +10 -10
- data/tools/staticdocs/docs/guides/monitoring.html +135 -20
- data/tools/staticdocs/docs/guides/performance.html +24 -15
- data/tools/staticdocs/docs/guides/raspberrypi.html +22 -7
- data/tools/staticdocs/docs/guides/script-writing.html +387 -82
- data/tools/staticdocs/docs/guides/scripting-api.html +1339 -476
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +17 -12
- data/tools/staticdocs/docs/meta/licenses.html +28 -10
- data/tools/staticdocs/docs/meta/philosophy.html +2 -2
- data/tools/staticdocs/docs/meta/xtce.html +14 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/autonomic.html +20 -20
- data/tools/staticdocs/docs/tools/bucket-explorer.html +11 -11
- data/tools/staticdocs/docs/tools/calendar.html +19 -19
- data/tools/staticdocs/docs/tools/cmd-sender.html +13 -13
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +21 -21
- data/tools/staticdocs/docs/tools/data-extractor.html +24 -24
- 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 +17 -17
- data/tools/staticdocs/docs/tools/packet-viewer.html +13 -13
- data/tools/staticdocs/docs/tools/script-runner.html +72 -33
- data/tools/staticdocs/docs/tools/table-manager.html +46 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +20 -20
- data/tools/staticdocs/docs/tools/tlm-viewer.html +15 -15
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +12 -12
- data/tools/staticdocs/index.html +2 -2
- data/tools/staticdocs/lunr-index-1710527361977.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1710527361977.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +86 -86
- data/tools/staticdocs/assets/js/019369f3.4c70e0f5.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.9fe67269.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.bec3d8d0.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.21af6e8e.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.821a434d.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.b7b2f0e7.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.69ac319c.js +0 -1
- data/tools/staticdocs/assets/js/13196248.50c46920.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.cd1ff3e4.js +0 -1
- data/tools/staticdocs/assets/js/1b2b4b61.bc9d9dae.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.a81749f4.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.8087c066.js +0 -1
- data/tools/staticdocs/assets/js/2684.36b8c775.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.b69bce6b.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.615ed3e3.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.4ee9bb2b.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.4c276089.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.dba1dcf4.js +0 -1
- data/tools/staticdocs/assets/js/42170351.7de5b38a.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.817db236.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.7c5b0f91.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.5600c9b0.js +0 -1
- data/tools/staticdocs/assets/js/5640.603af822.js +0 -2
- data/tools/staticdocs/assets/js/5b233ba7.816cf3c7.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.832101d0.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.29713d16.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.2a1df40b.js +0 -1
- data/tools/staticdocs/assets/js/6624.7d23f967.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.cb28ec2a.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.3f5260ea.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.3e207b70.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.f39c2a82.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.9247374f.js +0 -1
- data/tools/staticdocs/assets/js/80.7f39c110.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.1ad7ba44.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.ed8629f4.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.1efba1e7.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.05020154.js +0 -1
- data/tools/staticdocs/assets/js/99b59eea.ff86d64b.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.118681ad.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.d3e03463.js +0 -1
- data/tools/staticdocs/assets/js/a507c363.a5cb92f5.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.1e72219d.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.5e9c5fba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.bae800c5.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.ca25b65e.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.52733814.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.026c925c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.94275d3c.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.bd1deb3f.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6f45475a.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.65307471.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.1233a5c6.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.d43ffea3.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.32ff5b2f.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.5c73f3e4.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.694c3ff3.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.95630ed9.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.d4658c69.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.83046007.js +0 -1
- data/tools/staticdocs/assets/js/ebec1ccb.6f1d3fbf.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.b8e79235.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.a07830ee.js +0 -1
- data/tools/staticdocs/assets/js/main.4510cb33.js +0 -2
- data/tools/staticdocs/assets/js/runtime~main.87667807.js +0 -1
- data/tools/staticdocs/lunr-index-1707604600660.json +0 -1
- data/tools/staticdocs/search-doc-1707604600660.json +0 -1
- /data/tools/staticdocs/assets/js/{5640.603af822.js.LICENSE.txt → 7760.7f593c4f.js.LICENSE.txt} +0 -0
- /data/tools/staticdocs/assets/js/{main.4510cb33.js.LICENSE.txt → main.abd362be.js.LICENSE.txt} +0 -0
|
@@ -4,23 +4,24 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
6
|
<title data-rh="true">Commands | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><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 Files"><meta data-rh="true" property="og:description" content="Command Definition Files"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/command"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/command" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/command" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a4426211.css">
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.7575b058.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.abd362be.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><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><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><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><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><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><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><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><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><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></li></ul></li><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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><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></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Commands</span><meta itemprop="position" content="2"></li></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
|
|
12
|
-
<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 easist 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/"
|
|
11
|
+
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><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><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><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><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><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><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><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><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><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></li></ul></li><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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><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></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Commands</span><meta itemprop="position" content="2"></li></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 id="command-definition-files">Command Definition Files</h2>
|
|
12
|
+
<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 easist 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/">ASCII Table</a> is structured, files beginning with capital letters are processed before lower case letters.</p>
|
|
13
13
|
<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>
|
|
14
14
|
<div style="clear:both"></div>
|
|
15
|
-
<h1>Command Keywords</h1>
|
|
16
|
-
<h2
|
|
15
|
+
<h1 id="command-keywords">Command Keywords</h1>
|
|
16
|
+
<h2 id="command">COMMAND</h2>
|
|
17
17
|
<p><strong>Defines a new command packet</strong></p>
|
|
18
18
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target</td><td>Name of the target this command is associated with</td><td>True</td></tr><tr><td>Command</td><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><td>True</td></tr><tr><td>Endianness</td><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><td>True</td></tr><tr><td>Description</td><td>Description of this command which must be enclosed with quotes</td><td>False</td></tr></tbody></table>
|
|
19
19
|
<p>Example Usage:</p>
|
|
20
|
-
<
|
|
21
|
-
|
|
20
|
+
<pre><code class="language-ruby">COMMAND INST COLLECT BIG_ENDIAN "Start collect"
|
|
21
|
+
</code></pre>
|
|
22
|
+
<h2 id="command-modifiers">COMMAND Modifiers</h2>
|
|
22
23
|
<p>The following keywords must follow a COMMAND keyword.</p>
|
|
23
|
-
<h3
|
|
24
|
+
<h3 id="parameter">PARAMETER</h3>
|
|
24
25
|
<p><strong>Defines a command parameter in the current command packet</strong></p>
|
|
25
26
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters.</td><td>True</td></tr><tr><td>Bit Size</td><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><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this parameter<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span></td><td>True</td></tr></tbody></table>
|
|
26
27
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
@@ -28,56 +29,73 @@
|
|
|
28
29
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
29
30
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Default Value</td><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><td>True</td></tr><tr><td>Description</td><td>Description for this parameter which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
30
31
|
<p>Example Usage:</p>
|
|
31
|
-
<
|
|
32
|
-
|
|
32
|
+
<pre><code class="language-ruby">PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
|
|
33
|
+
PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
|
|
34
|
+
PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
|
|
35
|
+
PARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"
|
|
36
|
+
PARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"
|
|
37
|
+
</code></pre>
|
|
38
|
+
<h3 id="parameter-modifiers">PARAMETER Modifiers</h3>
|
|
33
39
|
<p>The following keywords must follow a PARAMETER keyword.</p>
|
|
34
|
-
<h4
|
|
40
|
+
<h4 id="format_string">FORMAT_STRING</h4>
|
|
35
41
|
<p><strong>Adds printf style formatting</strong></p>
|
|
36
42
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Format</td><td>How to format using printf syntax. For example, '0x%0X' will display the value in hex.</td><td>True</td></tr></tbody></table>
|
|
37
43
|
<p>Example Usage:</p>
|
|
38
|
-
<
|
|
39
|
-
|
|
44
|
+
<pre><code class="language-ruby">FORMAT_STRING "0x%0X"
|
|
45
|
+
</code></pre>
|
|
46
|
+
<h4 id="units">UNITS</h4>
|
|
40
47
|
<p><strong>Add displayed units</strong></p>
|
|
41
48
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Full Name</td><td>Full name of the units type, e.g. Celsius</td><td>True</td></tr><tr><td>Abbreviated</td><td>Abbreviation for the units, e.g. C</td><td>True</td></tr></tbody></table>
|
|
42
49
|
<p>Example Usage:</p>
|
|
43
|
-
<
|
|
44
|
-
|
|
50
|
+
<pre><code class="language-ruby">UNITS Celsius C
|
|
51
|
+
UNITS Kilometers KM
|
|
52
|
+
</code></pre>
|
|
53
|
+
<h4 id="description">DESCRIPTION</h4>
|
|
45
54
|
<p><strong>Override the defined description</strong></p>
|
|
46
55
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>The new description</td><td>True</td></tr></tbody></table>
|
|
47
|
-
<h4
|
|
56
|
+
<h4 id="meta">META</h4>
|
|
48
57
|
<p><strong>Stores custom user metadata</strong></p>
|
|
49
58
|
<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>
|
|
50
59
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Meta Name</td><td>Name of the metadata to store</td><td>True</td></tr><tr><td>Meta Values</td><td>One or more values to be stored for this Meta Name</td><td>False</td></tr></tbody></table>
|
|
51
60
|
<p>Example Usage:</p>
|
|
52
|
-
<
|
|
53
|
-
|
|
61
|
+
<pre><code class="language-ruby">META TEST "This parameter is for test purposes only"
|
|
62
|
+
</code></pre>
|
|
63
|
+
<h4 id="overlap">OVERLAP</h4>
|
|
54
64
|
<p></p><div class="right">(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
|
55
65
|
<p>If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message.</p>
|
|
56
|
-
<h4
|
|
66
|
+
<h4 id="key">KEY</h4>
|
|
57
67
|
<p></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>
|
|
58
68
|
<p>Keys are often JsonPath or XPath strings</p>
|
|
59
69
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key string</td><td>The key to access this item</td><td>True</td></tr></tbody></table>
|
|
60
70
|
<p>Example Usage:</p>
|
|
61
|
-
<
|
|
62
|
-
|
|
71
|
+
<pre><code class="language-ruby">KEY $.book.title
|
|
72
|
+
</code></pre>
|
|
73
|
+
<h4 id="required">REQUIRED</h4>
|
|
63
74
|
<p><strong>Parameter is required to be populated in scripts</strong></p>
|
|
64
75
|
<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>
|
|
65
|
-
<h4
|
|
76
|
+
<h4 id="minimum_value">MINIMUM_VALUE</h4>
|
|
66
77
|
<p><strong>Override the defined minimum value</strong></p>
|
|
67
78
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>The new minimum value for the parameter</td><td>True</td></tr></tbody></table>
|
|
68
|
-
<h4
|
|
79
|
+
<h4 id="maximum_value">MAXIMUM_VALUE</h4>
|
|
69
80
|
<p><strong>Override the defined maximum value</strong></p>
|
|
70
81
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>The new maximum value for the parameter</td><td>True</td></tr></tbody></table>
|
|
71
|
-
<h4
|
|
82
|
+
<h4 id="default_value">DEFAULT_VALUE</h4>
|
|
72
83
|
<p><strong>Override the defined default value</strong></p>
|
|
73
84
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>The new default value for the parameter</td><td>True</td></tr></tbody></table>
|
|
74
|
-
<h4
|
|
85
|
+
<h4 id="state">STATE</h4>
|
|
75
86
|
<p><strong>Defines a key/value pair for the current command parameter</strong></p>
|
|
76
87
|
<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>
|
|
77
88
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>The string state name</td><td>True</td></tr><tr><td>Value</td><td>The numerical state value</td><td>True</td></tr><tr><td>Hazardous / Disable Messages</td><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><td>False</td></tr><tr><td>Hazardous Description</td><td>String describing why this state is hazardous</td><td>False</td></tr></tbody></table>
|
|
78
89
|
<p>Example Usage:</p>
|
|
79
|
-
<
|
|
80
|
-
|
|
90
|
+
<pre><code class="language-ruby">APPEND_PARAMETER ENABLE 32 UINT 0 1 0 "Enable setting"
|
|
91
|
+
STATE FALSE 0
|
|
92
|
+
STATE TRUE 1
|
|
93
|
+
APPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"
|
|
94
|
+
STATE "NOOP" "NOOP" DISABLE_MESSAGES
|
|
95
|
+
STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"
|
|
96
|
+
STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"
|
|
97
|
+
</code></pre>
|
|
98
|
+
<h4 id="write_conversion">WRITE_CONVERSION</h4>
|
|
81
99
|
<p><strong>Applies a conversion when writing the current command parameter</strong></p>
|
|
82
100
|
<p>Conversions are implemented in a custom Ruby file which should be
|
|
83
101
|
located in the target's lib folder. The class must require 'openc3/conversions/conversion'
|
|
@@ -85,28 +103,48 @@ and inherit from Conversion. It must implement the initialize method if it
|
|
|
85
103
|
takes extra parameters and must always implement the call method. The conversion
|
|
86
104
|
factor is applied to the value entered by the user before it is written into
|
|
87
105
|
the binary command packet and sent.</p>
|
|
88
|
-
<
|
|
106
|
+
<admonition title="Multiple write conversions on command parameters" type="info"><p>When a command is built, each item gets written (and write conversions are run)
|
|
89
107
|
to set the default value. Then items are written (again write conversions are run)
|
|
90
108
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
91
109
|
no guarantees which parameters have already been written. The packet itself has a
|
|
92
110
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
93
|
-
values to the command. That can be used to check parameter values passed in.</p></
|
|
111
|
+
values to the command. That can be used to check parameter values passed in.</p></admonition>
|
|
94
112
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Class Filename</td><td>The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'.</td><td>True</td></tr><tr><td>Parameter</td><td>Additional parameter values for the conversion which are passed to the class constructor.</td><td>False</td></tr></tbody></table>
|
|
95
113
|
<p>Example Usage:</p>
|
|
96
|
-
<
|
|
97
|
-
|
|
114
|
+
<pre><code class="language-ruby">WRITE_CONVERSION the_great_conversion.rb 1000
|
|
115
|
+
|
|
116
|
+
Defined in the_great_conversion.rb:
|
|
117
|
+
|
|
118
|
+
require 'openc3/conversions/conversion'
|
|
119
|
+
module OpenC3
|
|
120
|
+
class TheGreatConversion < Conversion
|
|
121
|
+
def initialize(multiplier)
|
|
122
|
+
super()
|
|
123
|
+
@multiplier = multiplier.to_f
|
|
124
|
+
end
|
|
125
|
+
def call(value, packet, buffer)
|
|
126
|
+
return value * multiplier
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
</code></pre>
|
|
131
|
+
<h4 id="poly_write_conversion">POLY_WRITE_CONVERSION</h4>
|
|
98
132
|
<p><strong>Adds a polynomial conversion factor to the current command parameter</strong></p>
|
|
99
133
|
<p>The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent.</p>
|
|
100
134
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>C0</td><td>Coefficient</td><td>True</td></tr><tr><td>Cx</td><td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.</td><td>False</td></tr></tbody></table>
|
|
101
135
|
<p>Example Usage:</p>
|
|
102
|
-
<
|
|
103
|
-
|
|
136
|
+
<pre><code class="language-ruby">POLY_WRITE_CONVERSION 10 0.5 0.25
|
|
137
|
+
</code></pre>
|
|
138
|
+
<h4 id="seg_poly_write_conversion">SEG_POLY_WRITE_CONVERSION</h4>
|
|
104
139
|
<p><strong>Adds a segmented polynomial conversion factor to the current command parameter</strong></p>
|
|
105
140
|
<p>This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent.</p>
|
|
106
141
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Lower Bound</td><td>Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound.</td><td>True</td></tr><tr><td>C0</td><td>Coefficient</td><td>True</td></tr><tr><td>Cx</td><td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.</td><td>False</td></tr></tbody></table>
|
|
107
142
|
<p>Example Usage:</p>
|
|
108
|
-
<
|
|
109
|
-
|
|
143
|
+
<pre><code class="language-ruby">SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50
|
|
144
|
+
SEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100
|
|
145
|
+
SEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100
|
|
146
|
+
</code></pre>
|
|
147
|
+
<h4 id="generic_write_conversion_start">GENERIC_WRITE_CONVERSION_START</h4>
|
|
110
148
|
<p><strong>Start a generic write conversion</strong></p>
|
|
111
149
|
<p>Adds a generic conversion function to the current command parameter.
|
|
112
150
|
This conversion factor is applied to the value entered by the user before it
|
|
@@ -117,24 +155,29 @@ class (Note, referencing the packet as 'myself' is still supported for
|
|
|
117
155
|
compatibility). The last line of ruby code given should return the converted
|
|
118
156
|
value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
|
|
119
157
|
ruby code for the conversion have been given.</p>
|
|
120
|
-
<
|
|
158
|
+
<admonition title="Multiple write conversions on command parameters" type="info"><p>When a command is built, each item gets written (and write conversions are run)
|
|
121
159
|
to set the default value. Then items are written (again write conversions are run)
|
|
122
160
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
123
161
|
no guarantees which parameters have already been written. The packet itself has a
|
|
124
162
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
125
|
-
values to the command. That can be used to check parameter values passed in.</p></
|
|
126
|
-
<
|
|
163
|
+
values to the command. That can be used to check parameter values passed in.</p></admonition>
|
|
164
|
+
<admonition type="warning"><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.</p></admonition>
|
|
127
165
|
<p>Example Usage:</p>
|
|
128
|
-
<
|
|
129
|
-
|
|
166
|
+
<pre><code class="language-ruby">APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0
|
|
167
|
+
GENERIC_WRITE_CONVERSION_START
|
|
168
|
+
(value * 1.5).to_i # Convert the value by a scale factor
|
|
169
|
+
GENERIC_WRITE_CONVERSION_END
|
|
170
|
+
</code></pre>
|
|
171
|
+
<h4 id="generic_write_conversion_end">GENERIC_WRITE_CONVERSION_END</h4>
|
|
130
172
|
<p><strong>Complete a generic write conversion</strong></p>
|
|
131
|
-
<h4
|
|
173
|
+
<h4 id="overflow">OVERFLOW</h4>
|
|
132
174
|
<p><strong>Set the behavior when writing a value overflows the type</strong></p>
|
|
133
175
|
<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 writen, e.g. you can successfully write 255 to a 8 bit signed value.</p>
|
|
134
176
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Behavior</td><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><td>True</td></tr></tbody></table>
|
|
135
177
|
<p>Example Usage:</p>
|
|
136
|
-
<
|
|
137
|
-
|
|
178
|
+
<pre><code class="language-ruby">OVERFLOW TRUNCATE
|
|
179
|
+
</code></pre>
|
|
180
|
+
<h3 id="append_parameter">APPEND_PARAMETER</h3>
|
|
138
181
|
<p><strong>Defines a command parameter in the current command packet</strong></p>
|
|
139
182
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Bit Size</td><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><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this parameter<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span></td><td>True</td></tr></tbody></table>
|
|
140
183
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
@@ -142,8 +185,11 @@ values to the command. That can be used to check parameter values passed in.</p>
|
|
|
142
185
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
143
186
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Default Value</td><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><td>True</td></tr><tr><td>Description</td><td>Description for this parameter which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
144
187
|
<p>Example Usage:</p>
|
|
145
|
-
<
|
|
146
|
-
|
|
188
|
+
<pre><code class="language-ruby">APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
|
|
189
|
+
APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
|
|
190
|
+
APPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"
|
|
191
|
+
</code></pre>
|
|
192
|
+
<h3 id="id_parameter">ID_PARAMETER</h3>
|
|
147
193
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
|
148
194
|
<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>
|
|
149
195
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters.</td><td>True</td></tr><tr><td>Bit Size</td><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><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this parameter<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span></td><td>True</td></tr></tbody></table>
|
|
@@ -152,8 +198,9 @@ values to the command. That can be used to check parameter values passed in.</p>
|
|
|
152
198
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
153
199
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Default Value</td><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><td>True</td></tr><tr><td>Description</td><td>Description for this parameter which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
154
200
|
<p>Example Usage:</p>
|
|
155
|
-
<
|
|
156
|
-
|
|
201
|
+
<pre><code class="language-ruby">ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
|
|
202
|
+
</code></pre>
|
|
203
|
+
<h3 id="append_id_parameter">APPEND_ID_PARAMETER</h3>
|
|
157
204
|
<p><strong>Defines an identification command parameter in the current command packet</strong></p>
|
|
158
205
|
<p>ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified.</p>
|
|
159
206
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Bit Size</td><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><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this parameter<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span></td><td>True</td></tr></tbody></table>
|
|
@@ -162,79 +209,126 @@ values to the command. That can be used to check parameter values passed in.</p>
|
|
|
162
209
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
163
210
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Default Value</td><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><td>True</td></tr><tr><td>Description</td><td>Description for this parameter which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
164
211
|
<p>Example Usage:</p>
|
|
165
|
-
<
|
|
166
|
-
|
|
212
|
+
<pre><code class="language-ruby">APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
|
|
213
|
+
</code></pre>
|
|
214
|
+
<h3 id="array_parameter">ARRAY_PARAMETER</h3>
|
|
167
215
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
|
168
216
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters.</td><td>True</td></tr><tr><td>Item Bit Size</td><td>Bit size of each array item</td><td>True</td></tr><tr><td>Item Data Type</td><td>Data Type of each array item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span></td><td>True</td></tr><tr><td>Array Bit Size</td><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><td>True</td></tr><tr><td>Description</td><td>Description which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
169
217
|
<p>Example Usage:</p>
|
|
170
|
-
<
|
|
171
|
-
|
|
218
|
+
<pre><code class="language-ruby">ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
|
|
219
|
+
</code></pre>
|
|
220
|
+
<h3 id="append_array_parameter">APPEND_ARRAY_PARAMETER</h3>
|
|
172
221
|
<p><strong>Defines a command parameter in the current command packet that is an array</strong></p>
|
|
173
222
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the parameter. Must be unique within the command.</td><td>True</td></tr><tr><td>Item Bit Size</td><td>Bit size of each array item</td><td>True</td></tr><tr><td>Item Data Type</td><td>Data Type of each array item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span></td><td>True</td></tr><tr><td>Array Bit Size</td><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><td>True</td></tr><tr><td>Description</td><td>Description which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><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><td>False</td></tr></tbody></table>
|
|
174
223
|
<p>Example Usage:</p>
|
|
175
|
-
<
|
|
176
|
-
|
|
224
|
+
<pre><code class="language-ruby">APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
|
|
225
|
+
</code></pre>
|
|
226
|
+
<h3 id="select_parameter">SELECT_PARAMETER</h3>
|
|
177
227
|
<p><strong>Selects an existing command parameter for editing</strong></p>
|
|
178
228
|
<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>
|
|
179
229
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Parameter</td><td>Name of the parameter to select for modification</td><td>True</td></tr></tbody></table>
|
|
180
230
|
<p>Example Usage:</p>
|
|
181
|
-
<
|
|
182
|
-
|
|
231
|
+
<pre><code class="language-ruby">SELECT_COMMAND INST COLLECT
|
|
232
|
+
SELECT_PARAMETER DURATION
|
|
233
|
+
# Add units
|
|
234
|
+
UNITS Seconds S
|
|
235
|
+
</code></pre>
|
|
236
|
+
<h3 id="delete_parameter">DELETE_PARAMETER</h3>
|
|
183
237
|
<p></p><div class="right">(Since 4.4.1)</div><strong>Deletes an existing command parameter from the packet definition</strong><p></p>
|
|
184
238
|
<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>
|
|
185
239
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Parameter</td><td>Name of the parameter to delete</td><td>True</td></tr></tbody></table>
|
|
186
240
|
<p>Example Usage:</p>
|
|
187
|
-
<
|
|
188
|
-
|
|
241
|
+
<pre><code class="language-ruby">SELECT_COMMAND INST COLLECT
|
|
242
|
+
DELETE_PARAMETER DURATION
|
|
243
|
+
</code></pre>
|
|
244
|
+
<h3 id="hidden">HIDDEN</h3>
|
|
189
245
|
<p><strong>Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator</strong></p>
|
|
190
246
|
<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>
|
|
191
|
-
<h3
|
|
247
|
+
<h3 id="disabled">DISABLED</h3>
|
|
192
248
|
<p><strong>Disables this command from being sent</strong></p>
|
|
193
249
|
<p>Hides the command and also disables it from being sent by scripts. Attempts to send DISABLED commands result in an error message.</p>
|
|
194
|
-
<h3
|
|
250
|
+
<h3 id="disable_messages">DISABLE_MESSAGES</h3>
|
|
195
251
|
<p><strong>Disable the Server from printing cmd(...) messages. Commands are still logged.</strong></p>
|
|
196
|
-
<h3
|
|
252
|
+
<h3 id="meta-1">META</h3>
|
|
197
253
|
<p><strong>Stores metadata for the current command</strong></p>
|
|
198
254
|
<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>
|
|
199
255
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Meta Name</td><td>Name of the metadata to store</td><td>True</td></tr><tr><td>Meta Values</td><td>One or more values to be stored for this Meta Name</td><td>False</td></tr></tbody></table>
|
|
200
256
|
<p>Example Usage:</p>
|
|
201
|
-
<
|
|
202
|
-
|
|
257
|
+
<pre><code class="language-ruby">META FSW_TYPE "struct command"
|
|
258
|
+
</code></pre>
|
|
259
|
+
<h3 id="hazardous">HAZARDOUS</h3>
|
|
203
260
|
<p><strong>Designates the current command as hazardous</strong></p>
|
|
204
261
|
<p>Sending a hazardous command causes a dialog asking for confirmation before sending the command</p>
|
|
205
262
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Description</td><td>Description for why the command is hazardous which must be enclosed with quotes</td><td>False</td></tr></tbody></table>
|
|
206
|
-
<h3
|
|
263
|
+
<h3 id="accessor">ACCESSOR</h3>
|
|
207
264
|
<p></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>
|
|
208
265
|
<p>Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.</p>
|
|
209
266
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Accessor Class Name</td><td>The name of the accessor class</td><td>True</td></tr></tbody></table>
|
|
210
|
-
<h3
|
|
267
|
+
<h3 id="template">TEMPLATE</h3>
|
|
211
268
|
<p></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>
|
|
212
269
|
<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>
|
|
213
270
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Template</td><td>The template string which should be enclosed in quotes</td><td>True</td></tr></tbody></table>
|
|
214
|
-
<h3
|
|
271
|
+
<h3 id="template_file">TEMPLATE_FILE</h3>
|
|
215
272
|
<p></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>
|
|
216
273
|
<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>
|
|
217
274
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Template File Path</td><td>The relative path to the template file. Filename should generally start with an underscore.</td><td>True</td></tr></tbody></table>
|
|
218
|
-
<h3
|
|
275
|
+
<h3 id="response">RESPONSE</h3>
|
|
219
276
|
<p></p><div class="right">(Since 5.14.0)</div><strong>Indicates the expected telemetry packet response to this command</strong><p></p>
|
|
220
277
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target Name of telemetry response packet</td><td>True</td></tr><tr><td>Packet Name</td><td>Packet Name of telemetry response packet</td><td>True</td></tr></tbody></table>
|
|
221
|
-
<h3
|
|
278
|
+
<h3 id="error_response">ERROR_RESPONSE</h3>
|
|
222
279
|
<p></p><div class="right">(Since 5.14.0)</div><strong>Indicates the expected telemetry packet error response to this command</strong><p></p>
|
|
223
280
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target Name of telemetry error response packet</td><td>True</td></tr><tr><td>Packet Name</td><td>Packet Name of telemetry error response packet</td><td>True</td></tr></tbody></table>
|
|
224
|
-
<h3
|
|
281
|
+
<h3 id="related_item">RELATED_ITEM</h3>
|
|
225
282
|
<p></p><div class="right">(Since 5.14.0)</div><strong>Defines a related telemetry item to this command</strong><p></p>
|
|
226
283
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target Name of related telemetry item</td><td>True</td></tr><tr><td>Packet Name</td><td>Packet Name of related telemetry item</td><td>True</td></tr><tr><td>Item Name</td><td>Item Name of related telemetry item</td><td>True</td></tr></tbody></table>
|
|
227
|
-
<h3
|
|
284
|
+
<h3 id="screen">SCREEN</h3>
|
|
228
285
|
<p></p><div class="right">(Since 5.14.0)</div><strong>Defines a related telemetry screen to this command</strong><p></p>
|
|
229
286
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target Name of related telemetry screen</td><td>True</td></tr><tr><td>Screen Name</td><td>Screen Name of related telemetry screen</td><td>True</td></tr></tbody></table>
|
|
230
|
-
<h2
|
|
287
|
+
<h2 id="select_command">SELECT_COMMAND</h2>
|
|
231
288
|
<p><strong>Selects an existing command packet for editing</strong></p>
|
|
232
289
|
<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>
|
|
233
290
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Name of the target this command is associated with</td><td>True</td></tr><tr><td>Command Name</td><td>Name of the command to select</td><td>True</td></tr></tbody></table>
|
|
234
291
|
<p>Example Usage:</p>
|
|
235
|
-
<
|
|
236
|
-
|
|
292
|
+
<pre><code class="language-ruby">SELECT_COMMAND INST COLLECT
|
|
293
|
+
SELECT_PARAMETER DURATION
|
|
294
|
+
# Add units
|
|
295
|
+
UNITS Seconds S
|
|
296
|
+
</code></pre>
|
|
297
|
+
<h2 id="example-file">Example File</h2>
|
|
237
298
|
<p><strong>Example File: TARGET/cmd_tlm/cmd.txt</strong></p>
|
|
238
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_DATA</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Commands my target to collect data"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">180.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ANGLE OF INSTRUMENT IN DEGREES"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.01745</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DATA COLLECTION MODE"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NORMAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DIAG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NOOP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Do Nothing"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">101</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DUMMY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTINGS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Set the Settings"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER VERSION NUMBER"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET TYPE"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2047</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER APPLICATION ID"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE FLAGS"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16383</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER SEQUENCE COUNT"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PRIMARY HEADER PACKET LENGTH"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5.</span><span class="token plain">times </span><span class="token keyword" style="color:rgb(127, 219, 202)">do</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain">x</span><span class="token operator" style="color:rgb(127, 219, 202)">|</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">%></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token string-literal string" style="color:rgb(173, 219, 103)"> APPEND_PARAMETER SETTING<%= x %></span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Setting <%= x %>"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row 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"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Targets</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/telemetry"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Telemetry</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#command-definition-files" class="table-of-contents__link toc-highlight">Command Definition Files</a></li><li><a href="#command" class="table-of-contents__link toc-highlight">COMMAND</a></li><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><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><li><a href="#units" class="table-of-contents__link toc-highlight">UNITS</a></li><li><a href="#description" class="table-of-contents__link toc-highlight">DESCRIPTION</a></li><li><a href="#meta" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#overlap" class="table-of-contents__link toc-highlight">OVERLAP</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#required" class="table-of-contents__link toc-highlight">REQUIRED</a></li><li><a href="#minimum_value" class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a></li><li><a href="#maximum_value" class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a></li><li><a href="#default_value" class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a></li><li><a href="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#write_conversion" class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a></li><li><a href="#poly_write_conversion" class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a></li><li><a href="#seg_poly_write_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a></li><li><a href="#generic_write_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a></li><li><a href="#generic_write_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a></li><li><a href="#overflow" class="table-of-contents__link toc-highlight">OVERFLOW</a></li></ul></li><li><a href="#append_parameter" class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a></li><li><a href="#id_parameter" class="table-of-contents__link toc-highlight">ID_PARAMETER</a></li><li><a href="#append_id_parameter" class="table-of-contents__link toc-highlight">APPEND_ID_PARAMETER</a></li><li><a href="#array_parameter" class="table-of-contents__link toc-highlight">ARRAY_PARAMETER</a></li><li><a href="#append_array_parameter" class="table-of-contents__link toc-highlight">APPEND_ARRAY_PARAMETER</a></li><li><a href="#select_parameter" class="table-of-contents__link toc-highlight">SELECT_PARAMETER</a></li><li><a href="#delete_parameter" class="table-of-contents__link toc-highlight">DELETE_PARAMETER</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#disabled" class="table-of-contents__link toc-highlight">DISABLED</a></li><li><a href="#disable_messages" class="table-of-contents__link toc-highlight">DISABLE_MESSAGES</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#hazardous" class="table-of-contents__link toc-highlight">HAZARDOUS</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li><li><a href="#template" class="table-of-contents__link toc-highlight">TEMPLATE</a></li><li><a href="#template_file" class="table-of-contents__link toc-highlight">TEMPLATE_FILE</a></li><li><a href="#response" class="table-of-contents__link toc-highlight">RESPONSE</a></li><li><a href="#error_response" class="table-of-contents__link toc-highlight">ERROR_RESPONSE</a></li><li><a href="#related_item" class="table-of-contents__link toc-highlight">RELATED_ITEM</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li></ul></li><li><a href="#select_command" class="table-of-contents__link toc-highlight">SELECT_COMMAND</a></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
|
299
|
+
<pre><code class="language-ruby">COMMAND TARGET COLLECT_DATA BIG_ENDIAN "Commands my target to collect data"
|
|
300
|
+
PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"
|
|
301
|
+
PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"
|
|
302
|
+
PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"
|
|
303
|
+
ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 100 "CCSDS PRIMARY HEADER APPLICATION ID"
|
|
304
|
+
PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"
|
|
305
|
+
PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"
|
|
306
|
+
PARAMETER CCSDSLENGTH 32 16 UINT 4 4 4 "CCSDS PRIMARY HEADER PACKET LENGTH"
|
|
307
|
+
PARAMETER ANGLE 48 32 FLOAT -180.0 180.0 0.0 "ANGLE OF INSTRUMENT IN DEGREES"
|
|
308
|
+
POLY_WRITE_CONVERSION 0 0.01745 0 0
|
|
309
|
+
PARAMETER MODE 80 8 UINT 0 1 0 "DATA COLLECTION MODE"
|
|
310
|
+
STATE NORMAL 0
|
|
311
|
+
STATE DIAG 1
|
|
312
|
+
COMMAND TARGET NOOP BIG_ENDIAN "Do Nothing"
|
|
313
|
+
PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"
|
|
314
|
+
PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"
|
|
315
|
+
PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"
|
|
316
|
+
ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 101 "CCSDS PRIMARY HEADER APPLICATION ID"
|
|
317
|
+
PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"
|
|
318
|
+
PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"
|
|
319
|
+
PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"
|
|
320
|
+
PARAMETER DUMMY 48 8 UINT 0 0 0 "DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"
|
|
321
|
+
COMMAND TARGET SETTINGS BIG_ENDIAN "Set the Settings"
|
|
322
|
+
PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"
|
|
323
|
+
PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"
|
|
324
|
+
PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"
|
|
325
|
+
ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 102 "CCSDS PRIMARY HEADER APPLICATION ID"
|
|
326
|
+
PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"
|
|
327
|
+
PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"
|
|
328
|
+
PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"
|
|
329
|
+
<% 5.times do |x| %>
|
|
330
|
+
APPEND_PARAMETER SETTING<%= x %> 16 UINT 0 5 0 "Setting <%= x %>"
|
|
331
|
+
<% end %>
|
|
332
|
+
</code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row 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"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Targets</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/telemetry"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Telemetry</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#command-definition-files" class="table-of-contents__link toc-highlight">Command Definition Files</a></li><li><a href="#command" class="table-of-contents__link toc-highlight">COMMAND</a></li><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><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><li><a href="#units" class="table-of-contents__link toc-highlight">UNITS</a></li><li><a href="#description" class="table-of-contents__link toc-highlight">DESCRIPTION</a></li><li><a href="#meta" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#overlap" class="table-of-contents__link toc-highlight">OVERLAP</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#required" class="table-of-contents__link toc-highlight">REQUIRED</a></li><li><a href="#minimum_value" class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a></li><li><a href="#maximum_value" class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a></li><li><a href="#default_value" class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a></li><li><a href="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#write_conversion" class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a></li><li><a href="#poly_write_conversion" class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a></li><li><a href="#seg_poly_write_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a></li><li><a href="#generic_write_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a></li><li><a href="#generic_write_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a></li><li><a href="#overflow" class="table-of-contents__link toc-highlight">OVERFLOW</a></li></ul></li><li><a href="#append_parameter" class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a></li><li><a href="#id_parameter" class="table-of-contents__link toc-highlight">ID_PARAMETER</a></li><li><a href="#append_id_parameter" class="table-of-contents__link toc-highlight">APPEND_ID_PARAMETER</a></li><li><a href="#array_parameter" class="table-of-contents__link toc-highlight">ARRAY_PARAMETER</a></li><li><a href="#append_array_parameter" class="table-of-contents__link toc-highlight">APPEND_ARRAY_PARAMETER</a></li><li><a href="#select_parameter" class="table-of-contents__link toc-highlight">SELECT_PARAMETER</a></li><li><a href="#delete_parameter" class="table-of-contents__link toc-highlight">DELETE_PARAMETER</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#disabled" class="table-of-contents__link toc-highlight">DISABLED</a></li><li><a href="#disable_messages" class="table-of-contents__link toc-highlight">DISABLE_MESSAGES</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#hazardous" class="table-of-contents__link toc-highlight">HAZARDOUS</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li><li><a href="#template" class="table-of-contents__link toc-highlight">TEMPLATE</a></li><li><a href="#template_file" class="table-of-contents__link toc-highlight">TEMPLATE_FILE</a></li><li><a href="#response" class="table-of-contents__link toc-highlight">RESPONSE</a></li><li><a href="#error_response" class="table-of-contents__link toc-highlight">ERROR_RESPONSE</a></li><li><a href="#related_item" class="table-of-contents__link toc-highlight">RELATED_ITEM</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li></ul></li><li><a href="#select_command" class="table-of-contents__link toc-highlight">SELECT_COMMAND</a></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
|
239
333
|
</body>
|
|
240
334
|
</html>
|