openc3-cosmos-tool-docs 5.14.2 → 5.15.0
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.065a8213.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.db62873a.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.a6fe34c0.js +2 -0
- data/tools/staticdocs/assets/js/runtime~main.256dc9a2.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 +78 -27
- 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-1710043920959.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1710043920959.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.a6fe34c0.js.LICENSE.txt} +0 -0
|
@@ -4,195 +4,295 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
6
|
<title data-rh="true">Telemetry | 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/telemetry"><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="Telemetry | OpenC3 Docs"><meta data-rh="true" name="description" content="Telemetry Definition Files"><meta data-rh="true" property="og:description" content="Telemetry 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/telemetry"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" 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.256dc9a2.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.a6fe34c0.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" 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 menu__link--active" aria-current="page" 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">Telemetry</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>Telemetry</h1></header><h2
|
|
12
|
-
<p>Telemetry definition files define the telemetry packets that can be received and processed from COSMOS targets. One large file can be used to define the telemetry packets, or multiple files can be used at the user's discretion. Telemetry definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some telemetry files that depend on others, e.g. they override or extend existing telemetry, 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 tlm.txt you can create tlm_override.txt for telemetry that depends on the definitions in tlm.txt. 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" 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 menu__link--active" aria-current="page" 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">Telemetry</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>Telemetry</h1></header><h2 id="telemetry-definition-files">Telemetry Definition Files</h2>
|
|
12
|
+
<p>Telemetry definition files define the telemetry packets that can be received and processed from COSMOS targets. One large file can be used to define the telemetry packets, or multiple files can be used at the user's discretion. Telemetry definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some telemetry files that depend on others, e.g. they override or extend existing telemetry, 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 tlm.txt you can create tlm_override.txt for telemetry that depends on the definitions in tlm.txt. 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 telemetry items 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. Within COSMOS, the only difference between a STRING and BLOCK is when COSMOS reads a STRING type it stops reading when it encounters a null byte (0). This shows up when displaying the value in Packet Viewer or Tlm Viewer and in the output of Data Extractor. You should strive to store non-ASCII data inside BLOCK items and ASCII strings in STRING items.</p>
|
|
14
|
-
<
|
|
15
|
-
<h3
|
|
14
|
+
<admonition title="Printing Data" type="info"><p>Most data types can be printed in a COSMOS script simply by doing <code>puts tlm("TGT PKT ITEM")</code>. However, if the ITEM is a BLOCK data type and contains binary (non-ASCII) data then that won't work. COSMOS comes with a built-in method called <code>formatted</code> to help you view binary data. If ITEM is a BLOCK type containing binary try <code>puts tlm("TGT PKT ITEM").formatted</code> which will print the bytes out as hex.</p></admonition>
|
|
15
|
+
<h3 id="id-items">ID Items</h3>
|
|
16
16
|
<p>All packets require identification items so the incoming data can be matched to a packet structure. These items are defined using the <a href="/tools/staticdocs/docs/configuration/telemetry#id_item">ID_ITEM</a> and <a href="/tools/staticdocs/docs/configuration/telemetry#append_id_item">APPEND_ID_ITEM</a>. As data is read from the interface and refined by the protocol, the resulting packet is identified by matching all the ID fields. Note that ideally all packets in a particular target should use the exact same bit offset, bit size, and data type to identify. If this is not the case, you must set <a href="/tools/staticdocs/docs/configuration/target#tlm_unique_id_mode">TLM_UNIQUE_ID_MODE</a> in the target.txt file which incurs a performance penalty on every packet identification.</p>
|
|
17
|
-
<h3
|
|
17
|
+
<h3 id="variable-sized-items">Variable Sized Items</h3>
|
|
18
18
|
<p>COSMOS specifies a variable sized item with a bit size of 0. When a packet is identified, all other data that isn't explicitly defined will be put into the variable sized item. These items are typically used for packets containing memory dumps which vary in size depending on the number of bytes dumped. Note that there can only be one variable sized item per packet.</p>
|
|
19
|
-
<h3
|
|
19
|
+
<h3 id="derived-items">Derived Items</h3>
|
|
20
20
|
<p>COSMOS has a concept of a derived item which is a telemetry item that doesn't actually exist in the binary data. Derived items are typically computed based on other telemetry items. COSMOS derived items are very similar to real items except they use the special DERIVED data type. Here is how a derived item might look in a telemetry definition.</p>
|
|
21
|
-
<
|
|
21
|
+
<pre><code class="language-ruby">ITEM TEMP_AVERAGE 0 0 DERIVED "Average of TEMP1, TEMP2, TEMP3, TEMP4"
|
|
22
|
+
</code></pre>
|
|
22
23
|
<p>Note the bit offset and bit size of 0 and the data type of DERIVED. For this reason DERIVED items should be declared using ITEM rather than APPEND_ITEM. They can be defined anywhere in the packet definition but are typically placed at the end. The ITEM definition must be followed by a CONVERSION keyword, e.g. <a href="/tools/staticdocs/docs/configuration/telemetry#read_conversion">READ_CONVERSION</a>, to generate the value.</p>
|
|
23
|
-
<h3
|
|
24
|
+
<h3 id="received-time-and-packet-time">Received Time and Packet Time</h3>
|
|
24
25
|
<p>COSMOS automatically creates several telemetry items on every packet: PACKET_TIMESECONDS, PACKET_TIMEFORMATTED, RECEIVED_COUNT, RECEIVED_TIMEFORMATTED, and RECEIVED_TIMESECONDS.</p>
|
|
25
26
|
<p>RECEIVED_TIME is the time that COSMOS receives the packet. This is set by the interface which is connected to the target and is receiving the raw data. Once a packet has been created out of the raw data the time is set.</p>
|
|
26
27
|
<p>PACKET_TIME defaults to RECEIVED_TIME, but can be set as a derived item with a time object in the telemetry configuration file. This helps support stored telemetry packets so that they can be more reasonably handled by other COSMOS tools such as Telemetry Grapher and Data Extractor. You can set the 'stored' flag in your interface and the current value table is unaffected.</p>
|
|
27
28
|
<p>The _TIMEFORMATTED items returns the date and time in a YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->.sss format and the _TIMESECONDS returns the Unix seconds of the time.</p>
|
|
28
|
-
<h4
|
|
29
|
+
<h4 id="example">Example</h4>
|
|
29
30
|
<p>COSMOS provides a Unix time conversion class which returns a Ruby time object based on the number of seconds and (optionally) microseconds since the Unix epoch. Note: This returns a Ruby Time object and not a float or string!</p>
|
|
30
|
-
<
|
|
31
|
+
<pre><code>ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"
|
|
32
|
+
READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS
|
|
33
|
+
</code></pre>
|
|
31
34
|
<p>Definining PACKET_TIME allows the PACKET_TIMESECONDS and PACKET_TIMEFORMATTED to be calculated against an internal Packet time rather than the time COSMOS receives the packet.</p>
|
|
32
35
|
<div style="clear:both"></div>
|
|
33
|
-
<h1>Telemetry Keywords</h1>
|
|
34
|
-
<h2
|
|
36
|
+
<h1 id="telemetry-keywords">Telemetry Keywords</h1>
|
|
37
|
+
<h2 id="telemetry">TELEMETRY</h2>
|
|
35
38
|
<p><strong>Defines a new telemetry packet</strong></p>
|
|
36
39
|
<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 telemetry packet is associated with</td><td>True</td></tr><tr><td>Command</td><td>Name of this telemetry packet. Also referred to as its mnemonic. Must be unique to telemetry packets in 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 packet is 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 telemetry packet which must be enclosed with quotes</td><td>False</td></tr></tbody></table>
|
|
37
40
|
<p>Example Usage:</p>
|
|
38
|
-
<
|
|
39
|
-
|
|
41
|
+
<pre><code class="language-ruby">TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Instrument health and status"
|
|
42
|
+
</code></pre>
|
|
43
|
+
<h2 id="telemetry-modifiers">TELEMETRY Modifiers</h2>
|
|
40
44
|
<p>The following keywords must follow a TELEMETRY keyword.</p>
|
|
41
|
-
<h3
|
|
45
|
+
<h3 id="item">ITEM</h3>
|
|
42
46
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
43
47
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item.</td><td>True</td></tr><tr><td>Bit Size</td><td>Bit size of this telemetry item. 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 telemetry item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span></td><td>True</td></tr><tr><td>Description</td><td>Description for this telemetry item which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><td>Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on <a href="/tools/staticdocs/docs/guides/little-endian-bitfields">Little Endian Bitfields</a>.<br><br>Valid Values: <span class="values">BIG_ENDIAN, LITTLE_ENDIAN</span></td><td>False</td></tr></tbody></table>
|
|
44
48
|
<p>Example Usage:</p>
|
|
45
|
-
<
|
|
46
|
-
|
|
49
|
+
<pre><code class="language-ruby">ITEM PKTID 112 16 UINT "Packet ID"
|
|
50
|
+
ITEM DATA 0 0 DERIVED "Derived data"
|
|
51
|
+
</code></pre>
|
|
52
|
+
<h3 id="item-modifiers">ITEM Modifiers</h3>
|
|
47
53
|
<p>The following keywords must follow a ITEM keyword.</p>
|
|
48
|
-
<h4
|
|
54
|
+
<h4 id="format_string">FORMAT_STRING</h4>
|
|
49
55
|
<p><strong>Adds printf style formatting</strong></p>
|
|
50
56
|
<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>
|
|
51
57
|
<p>Example Usage:</p>
|
|
52
|
-
<
|
|
53
|
-
|
|
58
|
+
<pre><code class="language-ruby">FORMAT_STRING "0x%0X"
|
|
59
|
+
</code></pre>
|
|
60
|
+
<h4 id="units">UNITS</h4>
|
|
54
61
|
<p><strong>Add displayed units</strong></p>
|
|
55
62
|
<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>
|
|
56
63
|
<p>Example Usage:</p>
|
|
57
|
-
<
|
|
58
|
-
|
|
64
|
+
<pre><code class="language-ruby">UNITS Celsius C
|
|
65
|
+
UNITS Kilometers KM
|
|
66
|
+
</code></pre>
|
|
67
|
+
<h4 id="description">DESCRIPTION</h4>
|
|
59
68
|
<p><strong>Override the defined description</strong></p>
|
|
60
69
|
<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>
|
|
61
|
-
<h4
|
|
70
|
+
<h4 id="meta">META</h4>
|
|
62
71
|
<p><strong>Stores custom user metadata</strong></p>
|
|
63
72
|
<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>
|
|
64
73
|
<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>
|
|
65
74
|
<p>Example Usage:</p>
|
|
66
|
-
<
|
|
67
|
-
|
|
75
|
+
<pre><code class="language-ruby">META TEST "This parameter is for test purposes only"
|
|
76
|
+
</code></pre>
|
|
77
|
+
<h4 id="overlap">OVERLAP</h4>
|
|
68
78
|
<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>
|
|
69
79
|
<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>
|
|
70
|
-
<h4
|
|
80
|
+
<h4 id="key">KEY</h4>
|
|
71
81
|
<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>
|
|
72
82
|
<p>Keys are often JsonPath or XPath strings</p>
|
|
73
83
|
<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>
|
|
74
84
|
<p>Example Usage:</p>
|
|
75
|
-
<
|
|
76
|
-
|
|
85
|
+
<pre><code class="language-ruby">KEY $.book.title
|
|
86
|
+
</code></pre>
|
|
87
|
+
<h4 id="state">STATE</h4>
|
|
77
88
|
<p><strong>Defines a key/value pair for the current item</strong></p>
|
|
78
89
|
<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 telemetry item and allows for much greater clarity and less chance for user error. A catch all value of ANY applies to all other values not already defined as state values.</p>
|
|
79
90
|
<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 or ANY to apply the state to all other values</td><td>True</td></tr><tr><td>Color</td><td>The color the state should be displayed as<br><br>Valid Values: <span class="values">GREEN, YELLOW, RED</span></td><td>False</td></tr></tbody></table>
|
|
80
91
|
<p>Example Usage:</p>
|
|
81
|
-
<
|
|
82
|
-
|
|
92
|
+
<pre><code class="language-ruby">APPEND_ITEM ENABLE 32 UINT "Enable setting"
|
|
93
|
+
STATE FALSE 0
|
|
94
|
+
STATE TRUE 1
|
|
95
|
+
STATE ERROR ANY # Match all other values to ERROR
|
|
96
|
+
APPEND_ITEM STRING 1024 STRING "String"
|
|
97
|
+
STATE "NOOP" "NOOP" GREEN
|
|
98
|
+
STATE "ARM LASER" "ARM LASER" YELLOW
|
|
99
|
+
STATE "FIRE LASER" "FIRE LASER" RED
|
|
100
|
+
</code></pre>
|
|
101
|
+
<h4 id="read_conversion">READ_CONVERSION</h4>
|
|
83
102
|
<p><strong>Applies a conversion to the current telemetry item</strong></p>
|
|
84
103
|
<p>Conversions are implemented in a custom Ruby file which should be located in the target's lib folder. The class must require 'openc3/conversions/conversion' and inherit from Conversion. It must implement the initialize method if it takes extra parameters and must always implement the call method. The conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
85
104
|
<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>
|
|
86
105
|
<p>Example Usage:</p>
|
|
87
|
-
<
|
|
88
|
-
|
|
106
|
+
<pre><code class="language-ruby">READ_CONVERSION the_great_conversion.rb 1000
|
|
107
|
+
|
|
108
|
+
Defined in the_great_conversion.rb:
|
|
109
|
+
|
|
110
|
+
require 'openc3/conversions/conversion'
|
|
111
|
+
module OpenC3
|
|
112
|
+
class TheGreatConversion < Conversion
|
|
113
|
+
def initialize(multiplier)
|
|
114
|
+
super()
|
|
115
|
+
@multiplier = multiplier.to_f
|
|
116
|
+
end
|
|
117
|
+
def call(value, packet, buffer)
|
|
118
|
+
return value * @multiplier
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
</code></pre>
|
|
123
|
+
<h4 id="poly_read_conversion">POLY_READ_CONVERSION</h4>
|
|
89
124
|
<p><strong>Adds a polynomial conversion factor to the current telemetry item</strong></p>
|
|
90
125
|
<p>The conversion factor is applied to raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
91
126
|
<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>
|
|
92
127
|
<p>Example Usage:</p>
|
|
93
|
-
<
|
|
94
|
-
|
|
128
|
+
<pre><code class="language-ruby">POLY_READ_CONVERSION 10 0.5 0.25
|
|
129
|
+
</code></pre>
|
|
130
|
+
<h4 id="seg_poly_read_conversion">SEG_POLY_READ_CONVERSION</h4>
|
|
95
131
|
<p><strong>Adds a segmented polynomial conversion factor to the current telemetry item</strong></p>
|
|
96
132
|
<p>This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
97
133
|
<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>
|
|
98
134
|
<p>Example Usage:</p>
|
|
99
|
-
<
|
|
100
|
-
|
|
135
|
+
<pre><code class="language-ruby">SEG_POLY_READ_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50
|
|
136
|
+
SEG_POLY_READ_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100
|
|
137
|
+
SEG_POLY_READ_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100
|
|
138
|
+
</code></pre>
|
|
139
|
+
<h4 id="generic_read_conversion_start">GENERIC_READ_CONVERSION_START</h4>
|
|
101
140
|
<p><strong>Start a generic read conversion</strong></p>
|
|
102
141
|
<p>Adds a generic conversion function to the current telemetry item. This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog. The conversion is specified as ruby code that receives two implied parameters. 'value' which is the raw value being read and 'packet' which is a reference to the telemetry packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of ruby code given should return the converted value. The GENERIC_READ_CONVERSION_END keyword specifies that all lines of ruby code for the conversion have been given.</p>
|
|
103
|
-
<
|
|
142
|
+
<admonition type="warning"><p>Generic conversions are not a good long term solution. Consider creating a conversion class and using READ_CONVERSION instead. READ_CONVERSION is easier to debug and higher performance.</p></admonition>
|
|
104
143
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Converted Type</td><td>Type of the converted value<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK</span></td><td>False</td></tr><tr><td>Converted Bit Size</td><td>Bit size of converted value</td><td>False</td></tr></tbody></table>
|
|
105
144
|
<p>Example Usage:</p>
|
|
106
|
-
<
|
|
107
|
-
|
|
145
|
+
<pre><code class="language-ruby">APPEND_ITEM ITEM1 32 UINT
|
|
146
|
+
GENERIC_READ_CONVERSION_START
|
|
147
|
+
value * 1.5 # Convert the value by a scale factor
|
|
148
|
+
GENERIC_READ_CONVERSION_END
|
|
149
|
+
</code></pre>
|
|
150
|
+
<h4 id="generic_read_conversion_end">GENERIC_READ_CONVERSION_END</h4>
|
|
108
151
|
<p><strong>Complete a generic read conversion</strong></p>
|
|
109
|
-
<h4
|
|
152
|
+
<h4 id="limits">LIMITS</h4>
|
|
110
153
|
<p><strong>Defines a set of limits for a telemetry item</strong></p>
|
|
111
154
|
<p>If limits are violated a message is printed in the Command and Telemetry Server to indicate an item went out of limits. Other tools also use this information to update displays with different colored telemetry items or other useful information. The concept of "limits sets" is defined to allow for different limits values in different environments. For example, you might want tighter or looser limits on telemetry if your environment changes such as during thermal vacuum testing.</p>
|
|
112
155
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Limits Set</td><td>Name of the limits set. If you have no unique limits sets use the keyword DEFAULT.</td><td>True</td></tr><tr><td>Persistence</td><td>Number of consecutive times the telemetry item must be within a different limits range before changing limits state.</td><td>True</td></tr><tr><td>Initial State</td><td>Whether limits monitoring for this telemetry item is initially enabled or disabled. Note if you have multiple LIMITS items they should all have the same initial state.<br><br>Valid Values: <span class="values">ENABLED, DISABLED</span></td><td>True</td></tr><tr><td>Red Low Limit</td><td>If the telemetry value is less than or equal to this value a Red Low condition will be detected</td><td>True</td></tr><tr><td>Yellow Low Limit</td><td>If the telemetry value is less than or equal to this value, but greater than the Red Low Limit, a Yellow Low condition will be detected</td><td>True</td></tr><tr><td>Yellow High Limit</td><td>If the telemetry value is greater than or equal to this value, but less than the Red High Limit, a Yellow High condition will be detected</td><td>True</td></tr><tr><td>Red High Limit</td><td>If the telemetry value is greater than or equal to this value a Red High condition will be detected</td><td>True</td></tr><tr><td>Green Low Limit</td><td>Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is greater than or equal to this value, but less than the Green High Limit, a Blue operational condition will be detected.</td><td>False</td></tr><tr><td>Green High Limit</td><td>Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is less than or equal to this value, but greater than the Green Low Limit, a Blue operational condition will be detected.</td><td>False</td></tr></tbody></table>
|
|
113
156
|
<p>Example Usage:</p>
|
|
114
|
-
<
|
|
115
|
-
|
|
157
|
+
<pre><code class="language-ruby">LIMITS DEFAULT 3 ENABLED -80.0 -70.0 60.0 80.0 -20.0 20.0
|
|
158
|
+
LIMITS TVAC 3 ENABLED -80.0 -30.0 30.0 80.0
|
|
159
|
+
</code></pre>
|
|
160
|
+
<h4 id="limits_response">LIMITS_RESPONSE</h4>
|
|
116
161
|
<p><strong>Defines a response class that is called when the limits state of the current item changes</strong></p>
|
|
117
162
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Response Class Filename</td><td>Name of the Ruby file which implements the limits response. This file should be in the config/TARGET/lib directory so it can be found by OpenC3.</td><td>True</td></tr><tr><td>Response Specific Options</td><td>Variable length number of options that will be passed to the class constructor</td><td>False</td></tr></tbody></table>
|
|
118
163
|
<p>Example Usage:</p>
|
|
119
|
-
<
|
|
120
|
-
|
|
164
|
+
<pre><code class="language-ruby">LIMITS_RESPONSE example_limits_response.rb 10
|
|
165
|
+
</code></pre>
|
|
166
|
+
<h3 id="append_item">APPEND_ITEM</h3>
|
|
121
167
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
122
168
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Size</td><td>Bit size of this telemetry item. 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 telemetry item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span></td><td>True</td></tr><tr><td>Description</td><td>Description for this telemetry item which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><td>Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on <a href="/tools/staticdocs/docs/guides/little-endian-bitfields">Little Endian Bitfields</a>.<br><br>Valid Values: <span class="values">BIG_ENDIAN, LITTLE_ENDIAN</span></td><td>False</td></tr></tbody></table>
|
|
123
169
|
<p>Example Usage:</p>
|
|
124
|
-
<
|
|
125
|
-
|
|
170
|
+
<pre><code class="language-ruby">APPEND_ITEM PKTID 16 UINT "Packet ID"
|
|
171
|
+
</code></pre>
|
|
172
|
+
<h3 id="id_item">ID_ITEM</h3>
|
|
126
173
|
<p><strong>Defines a telemetry item in the current telemetry packet. Note, packets defined without one or more ID_ITEMs are "catch-all" packets which will match all incoming data. Normally this is the job of the UNKNOWN packet.</strong></p>
|
|
127
|
-
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet
|
|
174
|
+
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet.</td><td>True</td></tr><tr><td>Bit Size</td><td>Bit size of this telemetry item. 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.</td><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this telemetry item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK</span></td><td>True</td></tr><tr><td>ID Value</td><td>The value of this telemetry item that uniquely identifies this telemetry packet</td><td>True</td></tr><tr><td>Description</td><td>Description for this telemetry item which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><td>Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on <a href="/tools/staticdocs/docs/guides/little-endian-bitfields">Little Endian Bitfields</a>.<br><br>Valid Values: <span class="values">BIG_ENDIAN, LITTLE_ENDIAN</span></td><td>False</td></tr></tbody></table>
|
|
128
175
|
<p>Example Usage:</p>
|
|
129
|
-
<
|
|
130
|
-
|
|
176
|
+
<pre><code class="language-ruby">ID_ITEM PKTID 112 16 UINT 1 "Packet ID which must be 1"
|
|
177
|
+
</code></pre>
|
|
178
|
+
<h3 id="append_id_item">APPEND_ID_ITEM</h3>
|
|
131
179
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
132
|
-
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Size</td><td>Bit size of this telemetry item. 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
|
|
180
|
+
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Size</td><td>Bit size of this telemetry item. 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.</td><td>True</td></tr><tr><td>Data Type</td><td>Data Type of this telemetry item<br><br>Valid Values: <span class="values">INT, UINT, FLOAT, STRING, BLOCK</span></td><td>True</td></tr><tr><td>ID Value</td><td>The value of this telemetry item that uniquely identifies this telemetry packet</td><td>True</td></tr><tr><td>Description</td><td>Description for this telemetry item which must be enclosed with quotes</td><td>False</td></tr><tr><td>Endianness</td><td>Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on <a href="/tools/staticdocs/docs/guides/little-endian-bitfields">Little Endian Bitfields</a>.<br><br>Valid Values: <span class="values">BIG_ENDIAN, LITTLE_ENDIAN</span></td><td>False</td></tr></tbody></table>
|
|
133
181
|
<p>Example Usage:</p>
|
|
134
|
-
<
|
|
135
|
-
|
|
182
|
+
<pre><code class="language-ruby">APPEND_ID_ITEM PKTID 16 UINT 1 "Packet ID which must be 1"
|
|
183
|
+
</code></pre>
|
|
184
|
+
<h3 id="array_item">ARRAY_ITEM</h3>
|
|
136
185
|
<p><strong>Defines a telemetry item in the current telemetry packet that is an array</strong></p>
|
|
137
186
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</td><td>True</td></tr><tr><td>Bit Offset</td><td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item.</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>
|
|
138
187
|
<p>Example Usage:</p>
|
|
139
|
-
<
|
|
140
|
-
|
|
188
|
+
<pre><code class="language-ruby">ARRAY_ITEM ARRAY 64 32 FLOAT 320 "Array of 10 floats"
|
|
189
|
+
</code></pre>
|
|
190
|
+
<h3 id="append_array_item">APPEND_ARRAY_ITEM</h3>
|
|
141
191
|
<p><strong>Defines a telemetry item in the current telemetry packet that is an array</strong></p>
|
|
142
192
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the telemety item. Must be unique within the packet.</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>
|
|
143
193
|
<p>Example Usage:</p>
|
|
144
|
-
<
|
|
145
|
-
|
|
194
|
+
<pre><code class="language-ruby">APPEND_ARRAY_ITEM ARRAY 32 FLOAT 320 "Array of 10 floats"
|
|
195
|
+
</code></pre>
|
|
196
|
+
<h3 id="select_item">SELECT_ITEM</h3>
|
|
146
197
|
<p><strong>Selects an existing telemetry item for editing</strong></p>
|
|
147
198
|
<p>Must be used in conjunction with SELECT_TELEMETRY to first select the packet. Typically used to override generated values or make specific changes to telemetry that only affect a particular instance of a target used multiple times.</p>
|
|
148
199
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Item</td><td>Name of the item to select for modification</td><td>True</td></tr></tbody></table>
|
|
149
200
|
<p>Example Usage:</p>
|
|
150
|
-
<
|
|
151
|
-
|
|
201
|
+
<pre><code class="language-ruby">SELECT_TELEMETRY INST HEALTH_STATUS
|
|
202
|
+
SELECT_ITEM TEMP1
|
|
203
|
+
# Define limits for this item, overrides or replaces any existing
|
|
204
|
+
LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
|
|
205
|
+
</code></pre>
|
|
206
|
+
<h3 id="delete_item">DELETE_ITEM</h3>
|
|
152
207
|
<p></p><div class="right">(Since 4.4.1)</div><strong>Delete an existing telemetry item from the packet definition</strong><p></p>
|
|
153
208
|
<p>Deleting an item from the packet definition does not remove the defined space for that item. Thus unless you redefine a new item, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_TELEMETRY and then ITEM to define a new item.</p>
|
|
154
209
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Item</td><td>Name of the item to delete</td><td>True</td></tr></tbody></table>
|
|
155
210
|
<p>Example Usage:</p>
|
|
156
|
-
<
|
|
157
|
-
|
|
211
|
+
<pre><code class="language-ruby">SELECT_TELEMETRY INST HEALTH_STATUS
|
|
212
|
+
DELETE_ITEM TEMP4
|
|
213
|
+
</code></pre>
|
|
214
|
+
<h3 id="meta-1">META</h3>
|
|
158
215
|
<p><strong>Stores metadata for the current telemetry packet</strong></p>
|
|
159
216
|
<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>
|
|
160
217
|
<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>
|
|
161
218
|
<p>Example Usage:</p>
|
|
162
|
-
<
|
|
163
|
-
|
|
219
|
+
<pre><code class="language-ruby">META FSW_TYPE "struct tlm_packet"
|
|
220
|
+
</code></pre>
|
|
221
|
+
<h3 id="processor">PROCESSOR</h3>
|
|
164
222
|
<p><strong>Defines a processor class that executes code every time a packet is received</strong></p>
|
|
165
223
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Processor Name</td><td>The name of the processor</td><td>True</td></tr><tr><td>Processor Class Filename</td><td>Name of the Ruby file which implements the processor. This file should be in the config/TARGET/lib directory so it can be found by OpenC3.</td><td>True</td></tr><tr><td>Processor Specific Options</td><td>Variable length number of options that will be passed to the class constructor.</td><td>False</td></tr></tbody></table>
|
|
166
224
|
<p>Example Usage:</p>
|
|
167
|
-
<
|
|
168
|
-
|
|
225
|
+
<pre><code class="language-ruby">PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1
|
|
226
|
+
</code></pre>
|
|
227
|
+
<h3 id="allow_short">ALLOW_SHORT</h3>
|
|
169
228
|
<p><strong>Process telemetry packets which are less than their defined length</strong></p>
|
|
170
229
|
<p>Allows the telemetry packet to be received with a data portion that is smaller than the defined size without warnings. Any extra space in the packet will be filled in with zeros by OpenC3.</p>
|
|
171
|
-
<h3
|
|
230
|
+
<h3 id="hidden">HIDDEN</h3>
|
|
172
231
|
<p><strong>Hides this telemetry packet from all the OpenC3 tools</strong></p>
|
|
173
232
|
<p>This packet will not appear in Packet Viewer, Telemetry Grapher and Handbook Creator. It also hides this telemetry from appearing in the Script Runner popup helper when writing scripts. The telemetry still exists in the system and can received and checked by scripts.</p>
|
|
174
|
-
<h3
|
|
233
|
+
<h3 id="accessor">ACCESSOR</h3>
|
|
175
234
|
<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>
|
|
176
235
|
<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>
|
|
177
236
|
<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>
|
|
178
|
-
<h2
|
|
237
|
+
<h2 id="select_telemetry">SELECT_TELEMETRY</h2>
|
|
179
238
|
<p><strong>Selects an existing telemetry packet for editing</strong></p>
|
|
180
239
|
<p>Typically used in a separate configuration file from where the original telemetry is defined to override or add to the existing telemetry definition. Must be used in conjunction with SELECT_ITEM to change an individual item.</p>
|
|
181
240
|
<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 telemetry packet is associated with</td><td>True</td></tr><tr><td>Packet Name</td><td>Name of the telemetry packet to select</td><td>True</td></tr></tbody></table>
|
|
182
241
|
<p>Example Usage:</p>
|
|
183
|
-
<
|
|
184
|
-
|
|
242
|
+
<pre><code class="language-ruby">SELECT_TELEMETRY INST HEALTH_STATUS
|
|
243
|
+
SELECT_ITEM TEMP1
|
|
244
|
+
# Define limits for this item, overrides or replaces any existing
|
|
245
|
+
LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
|
|
246
|
+
</code></pre>
|
|
247
|
+
<h2 id="limits_group">LIMITS_GROUP</h2>
|
|
185
248
|
<p><strong>Defines a group of related limits Items</strong></p>
|
|
186
249
|
<p>Limits groups contain telemetry items that can be enabled and disabled together. It can be used to group related limits as a subsystem that can be enabled or disabled as that particular subsystem is powered (for example). To enable a group call the enable_limits_group("NAME") method in Script Runner. To disable a group call the disable_limits_group("NAME") in Script Runner. Items can belong to multiple groups but the last enabled or disabled group "wins". For example, if an item belongs to GROUP1 and GROUP2 and you first enable GROUP1 and then disable GROUP2 the item will be disabled. If you then enable GROUP1 again it will be enabled.</p>
|
|
187
250
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Group Name</td><td>Name of the limits group</td><td>True</td></tr></tbody></table>
|
|
188
|
-
<h2
|
|
251
|
+
<h2 id="limits_group_item">LIMITS_GROUP_ITEM</h2>
|
|
189
252
|
<p><strong>Adds the specified telemetry item to the last defined LIMITS_GROUP</strong></p>
|
|
190
253
|
<p>Limits group information is typically kept in a separate configuration file in the config/TARGET/cmd_tlm folder named limits_groups.txt.</p>
|
|
191
254
|
<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</td><td>True</td></tr><tr><td>Packet Name</td><td>Name of the packet</td><td>True</td></tr><tr><td>Item Name</td><td>Name of the telemetry item to add to the group</td><td>True</td></tr></tbody></table>
|
|
192
255
|
<p>Example Usage:</p>
|
|
193
|
-
<
|
|
194
|
-
|
|
256
|
+
<pre><code class="language-ruby">LIMITS_GROUP SUBSYSTEM
|
|
257
|
+
LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
|
|
258
|
+
LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
|
|
259
|
+
LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3
|
|
260
|
+
</code></pre>
|
|
261
|
+
<h2 id="example-file">Example File</h2>
|
|
195
262
|
<p><strong>Example File: TARGET/cmd_tlm/tlm.txt</strong></p>
|
|
196
|
-
<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)">TELEMETRY</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)">HS</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)">"Health and Status for My Target"</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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET VERSION NUMBER (SEE CCSDS 133.0-B-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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET TYPE (COMMAND OR TELEMETRY)"</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)">TLM</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)">CMD</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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS 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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID_ITEM</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)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS APPLICATION PROCESS 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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS 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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIRST</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)">CONT</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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LAST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</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)">NOGROUP</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET 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)">ITEM</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET DATA 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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSDAY</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)">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 string-literal string" style="color:rgb(173, 219, 103)">"DAYS SINCE EPOCH (JANUARY 1ST, 1958, MIDNIGHT)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSMSOD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"MILLISECONDS OF DAY (0 - 86399999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSUSOMS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">96</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">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 string-literal string" style="color:rgb(173, 219, 103)">"MICROSECONDS OF MILLISECOND (0-999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLEDEG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">112</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)">INT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Instrument Angle 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_READ_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)">57.295</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)">ITEM</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)">128</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 string-literal string" style="color:rgb(173, 219, 103)">"Instrument 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><span class="token constant" style="color:rgb(130, 170, 255)">GREEN</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><span class="token constant" style="color:rgb(130, 170, 255)">YELLOW</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESECONDS</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH IN SECONDS"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_START</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">86400.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1000000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_END</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMEFORMATTED</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH AS A FORMATTED STRING"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_START</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">216</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> time </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">Time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">ccsds2mdy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> sprintf</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'%04u/%02u/%02u %02u:%02u:%02u.%06u'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></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/telemetry.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/command"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interfaces</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="#telemetry-definition-files" class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href="#id-items" class="table-of-contents__link toc-highlight">ID Items</a></li><li><a href="#variable-sized-items" class="table-of-contents__link toc-highlight">Variable Sized Items</a></li><li><a href="#derived-items" class="table-of-contents__link toc-highlight">Derived Items</a></li><li><a href="#received-time-and-packet-time" class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li></ul></li></ul></li><li><a href="#telemetry" class="table-of-contents__link toc-highlight">TELEMETRY</a></li><li><a href="#telemetry-modifiers" class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#item-modifiers" class="table-of-contents__link toc-highlight">ITEM 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="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#read_conversion" class="table-of-contents__link toc-highlight">READ_CONVERSION</a></li><li><a href="#poly_read_conversion" class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a></li><li><a href="#seg_poly_read_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a></li><li><a href="#generic_read_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a></li><li><a href="#generic_read_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a></li><li><a href="#limits" class="table-of-contents__link toc-highlight">LIMITS</a></li><li><a href="#limits_response" class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></li></ul></li><li><a href="#append_item" class="table-of-contents__link toc-highlight">APPEND_ITEM</a></li><li><a href="#id_item" class="table-of-contents__link toc-highlight">ID_ITEM</a></li><li><a href="#append_id_item" class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a></li><li><a href="#array_item" class="table-of-contents__link toc-highlight">ARRAY_ITEM</a></li><li><a href="#append_array_item" class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a></li><li><a href="#select_item" class="table-of-contents__link toc-highlight">SELECT_ITEM</a></li><li><a href="#delete_item" class="table-of-contents__link toc-highlight">DELETE_ITEM</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#processor" class="table-of-contents__link toc-highlight">PROCESSOR</a></li><li><a href="#allow_short" class="table-of-contents__link toc-highlight">ALLOW_SHORT</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li></ul></li><li><a href="#select_telemetry" class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a></li><li><a href="#limits_group" class="table-of-contents__link toc-highlight">LIMITS_GROUP</a></li><li><a href="#limits_group_item" class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</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>
|
|
263
|
+
<pre><code class="language-ruby">TELEMETRY TARGET HS BIG_ENDIAN "Health and Status for My Target"
|
|
264
|
+
ITEM CCSDSVER 0 3 UINT "CCSDS PACKET VERSION NUMBER (SEE CCSDS 133.0-B-1)"
|
|
265
|
+
ITEM CCSDSTYPE 3 1 UINT "CCSDS PACKET TYPE (COMMAND OR TELEMETRY)"
|
|
266
|
+
STATE TLM 0
|
|
267
|
+
STATE CMD 1
|
|
268
|
+
ITEM CCSDSSHF 4 1 UINT "CCSDS SECONDARY HEADER FLAG"
|
|
269
|
+
STATE FALSE 0
|
|
270
|
+
STATE TRUE 1
|
|
271
|
+
ID_ITEM CCSDSAPID 5 11 UINT 102 "CCSDS APPLICATION PROCESS ID"
|
|
272
|
+
ITEM CCSDSSEQFLAGS 16 2 UINT "CCSDS SEQUENCE FLAGS"
|
|
273
|
+
STATE FIRST 0
|
|
274
|
+
STATE CONT 1
|
|
275
|
+
STATE LAST 2
|
|
276
|
+
STATE NOGROUP 3
|
|
277
|
+
ITEM CCSDSSEQCNT 18 14 UINT "CCSDS PACKET SEQUENCE COUNT"
|
|
278
|
+
ITEM CCSDSLENGTH 32 16 UINT "CCSDS PACKET DATA LENGTH"
|
|
279
|
+
ITEM CCSDSDAY 48 16 UINT "DAYS SINCE EPOCH (JANUARY 1ST, 1958, MIDNIGHT)"
|
|
280
|
+
ITEM CCSDSMSOD 64 32 UINT "MILLISECONDS OF DAY (0 - 86399999)"
|
|
281
|
+
ITEM CCSDSUSOMS 96 16 UINT "MICROSECONDS OF MILLISECOND (0-999)"
|
|
282
|
+
ITEM ANGLEDEG 112 16 INT "Instrument Angle in Degrees"
|
|
283
|
+
POLY_READ_CONVERSION 0 57.295
|
|
284
|
+
ITEM MODE 128 8 UINT "Instrument Mode"
|
|
285
|
+
STATE NORMAL 0 GREEN
|
|
286
|
+
STATE DIAG 1 YELLOW
|
|
287
|
+
ITEM TIMESECONDS 0 0 DERIVED "DERIVED TIME SINCE EPOCH IN SECONDS"
|
|
288
|
+
GENERIC_READ_CONVERSION_START FLOAT 32
|
|
289
|
+
((packet.read('ccsdsday') * 86400.0) + (packet.read('ccsdsmsod') / 1000.0) + (packet.read('ccsdsusoms') / 1000000.0) )
|
|
290
|
+
GENERIC_READ_CONVERSION_END
|
|
291
|
+
ITEM TIMEFORMATTED 0 0 DERIVED "DERIVED TIME SINCE EPOCH AS A FORMATTED STRING"
|
|
292
|
+
GENERIC_READ_CONVERSION_START STRING 216
|
|
293
|
+
time = Time.ccsds2mdy(packet.read('ccsdsday'), packet.read('ccsdsmsod'), packet.read('ccsdsusoms'))
|
|
294
|
+
sprintf('%04u/%02u/%02u %02u:%02u:%02u.%06u', time[0], time[1], time[2], time[3], time[4], time[5], time[6])
|
|
295
|
+
GENERIC_READ_CONVERSION_END
|
|
296
|
+
</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/telemetry.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/command"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interfaces</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="#telemetry-definition-files" class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href="#id-items" class="table-of-contents__link toc-highlight">ID Items</a></li><li><a href="#variable-sized-items" class="table-of-contents__link toc-highlight">Variable Sized Items</a></li><li><a href="#derived-items" class="table-of-contents__link toc-highlight">Derived Items</a></li><li><a href="#received-time-and-packet-time" class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li></ul></li></ul></li><li><a href="#telemetry" class="table-of-contents__link toc-highlight">TELEMETRY</a></li><li><a href="#telemetry-modifiers" class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#item-modifiers" class="table-of-contents__link toc-highlight">ITEM 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="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#read_conversion" class="table-of-contents__link toc-highlight">READ_CONVERSION</a></li><li><a href="#poly_read_conversion" class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a></li><li><a href="#seg_poly_read_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a></li><li><a href="#generic_read_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a></li><li><a href="#generic_read_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a></li><li><a href="#limits" class="table-of-contents__link toc-highlight">LIMITS</a></li><li><a href="#limits_response" class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></li></ul></li><li><a href="#append_item" class="table-of-contents__link toc-highlight">APPEND_ITEM</a></li><li><a href="#id_item" class="table-of-contents__link toc-highlight">ID_ITEM</a></li><li><a href="#append_id_item" class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a></li><li><a href="#array_item" class="table-of-contents__link toc-highlight">ARRAY_ITEM</a></li><li><a href="#append_array_item" class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a></li><li><a href="#select_item" class="table-of-contents__link toc-highlight">SELECT_ITEM</a></li><li><a href="#delete_item" class="table-of-contents__link toc-highlight">DELETE_ITEM</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#processor" class="table-of-contents__link toc-highlight">PROCESSOR</a></li><li><a href="#allow_short" class="table-of-contents__link toc-highlight">ALLOW_SHORT</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li></ul></li><li><a href="#select_telemetry" class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a></li><li><a href="#limits_group" class="table-of-contents__link toc-highlight">LIMITS_GROUP</a></li><li><a href="#limits_group_item" class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</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>
|
|
197
297
|
</body>
|
|
198
298
|
</html>
|