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,45 +4,50 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
6
|
<title data-rh="true">Screens | 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-screens"><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="Screens | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><meta data-rh="true" property="og:description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><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-screens"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" 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
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" 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 menu__link--active" aria-current="page" 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">Screens</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>Screens</h1></header><p>This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p>
|
|
12
12
|
<div style="clear:both"></div>
|
|
13
|
-
<h2
|
|
13
|
+
<h2 id="definitions">Definitions</h2>
|
|
14
14
|
<table><thead><tr><th>Name</th><th>Definition</th></tr></thead><tbody><tr><td>Widget</td><td>A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task.</td></tr><tr><td>Screen</td><td>A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion.</td></tr><tr><td>Screen Definition File</td><td>A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them.</td></tr></tbody></table>
|
|
15
|
-
<h2
|
|
15
|
+
<h2 id="telemetry-screen-definition-files">Telemetry Screen Definition Files</h2>
|
|
16
16
|
<p>Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target's screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase.</p>
|
|
17
|
-
<h2
|
|
17
|
+
<h2 id="new-widgets">New Widgets</h2>
|
|
18
18
|
<p>When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide.</p>
|
|
19
|
-
<h1>Screen Keywords</h1>
|
|
20
|
-
<h2
|
|
19
|
+
<h1 id="screen-keywords">Screen Keywords</h1>
|
|
20
|
+
<h2 id="screen">SCREEN</h2>
|
|
21
21
|
<p><strong>Define a telemetry viewer screen</strong></p>
|
|
22
22
|
<p>The SCREEN keyword is the first keyword in any telemetry screen definition. It defines the name of the screen and parameters that affect the screen overall.</p>
|
|
23
23
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen</td><td>True</td></tr><tr><td>Polling Period</td><td>Number of seconds between screen updates</td><td>True</td></tr></tbody></table>
|
|
24
24
|
<p>Example Usage:</p>
|
|
25
|
-
<
|
|
26
|
-
|
|
25
|
+
<pre><code class="language-ruby">SCREEN AUTO AUTO 1.0 FIXED
|
|
26
|
+
</code></pre>
|
|
27
|
+
<h2 id="end">END</h2>
|
|
27
28
|
<p><strong>Indicates the close of a layout widget</strong></p>
|
|
28
29
|
<p>All layout widgets must be closed to properly identify where they stop. For example, a VERTICALBOX keyword must be matched with an END keyword to indicate where the VERTICALBOX ends.</p>
|
|
29
|
-
<h2
|
|
30
|
+
<h2 id="stale_time">STALE_TIME</h2>
|
|
30
31
|
<p></p><div class="right">(Since 5.1.0)</div><strong>Values are marked stale if the packet time is more than Stale Time seconds in the past</strong><p></p>
|
|
31
32
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>value</td><td>Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale. The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions.</td><td>True</td></tr></tbody></table>
|
|
32
33
|
<p>Example Usage:</p>
|
|
33
|
-
<
|
|
34
|
-
|
|
34
|
+
<pre><code class="language-ruby">STALE_TIME 5 # Number of seconds to wait before marking data stale
|
|
35
|
+
</code></pre>
|
|
36
|
+
<h2 id="global_setting">GLOBAL_SETTING</h2>
|
|
35
37
|
<p><strong>Applies a widget setting to all widgets of a certain type</strong></p>
|
|
36
38
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Class Name</td><td>The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON.</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table>
|
|
37
39
|
<p>Example Usage:</p>
|
|
38
|
-
<
|
|
39
|
-
|
|
40
|
+
<pre><code class="language-ruby">GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK
|
|
41
|
+
</code></pre>
|
|
42
|
+
<h2 id="global_subsetting">GLOBAL_SUBSETTING</h2>
|
|
40
43
|
<p><strong>Applies a widget subsetting to all widgets of a certain type</strong></p>
|
|
41
44
|
<p>Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL.</p>
|
|
42
45
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Class Name</td><td>The name of the class of widgets that this setting will be applied to. For example, LABELVALUE.</td><td>True</td></tr><tr><td>Subwidget Index</td><td>Index to the desired subwidget</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table>
|
|
43
46
|
<p>Example Usage:</p>
|
|
44
|
-
<
|
|
45
|
-
|
|
47
|
+
<pre><code class="language-ruby"># Set all text color to white for labelvaluelimitsbars
|
|
48
|
+
GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
|
|
49
|
+
</code></pre>
|
|
50
|
+
<h2 id="setting">SETTING</h2>
|
|
46
51
|
<p><strong>Applies a widget setting to the previously defined widget</strong></p>
|
|
47
52
|
<p>Settings allow for additional tweaks and options to be applied to widgets
|
|
48
53
|
that are not available in their parameters. These settings are all configured
|
|
@@ -51,367 +56,532 @@ SETTING and SUBSETTING applies only to the widget defined immediately before it.
|
|
|
51
56
|
GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.</p>
|
|
52
57
|
<p>Common wiget settings are defined here. Some widgets define their own
|
|
53
58
|
unqiue settings which are documented under that specific widget.</p>
|
|
54
|
-
<h3
|
|
59
|
+
<h3 id="width">WIDTH</h3>
|
|
55
60
|
<p><strong>Sets the widget width</strong></p>
|
|
56
|
-
<p>WIDTH supports <a href="https://www.w3schools.com/cssref/css_units.php"
|
|
61
|
+
<p>WIDTH supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p>
|
|
57
62
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table>
|
|
58
63
|
<p>Example Usage:</p>
|
|
59
|
-
<
|
|
60
|
-
|
|
64
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
65
|
+
SETTING WIDTH 50
|
|
66
|
+
LABEL "THIS IS A TEST"
|
|
67
|
+
SETTING WIDTH 20em
|
|
68
|
+
</code></pre>
|
|
69
|
+
<h3 id="height">HEIGHT</h3>
|
|
61
70
|
<p><strong>Sets the widget height</strong></p>
|
|
62
|
-
<p>HEIGHT supports <a href="https://www.w3schools.com/cssref/css_units.php"
|
|
71
|
+
<p>HEIGHT supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p>
|
|
63
72
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Height</td><td>Height in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table>
|
|
64
73
|
<p>Example Usage:</p>
|
|
65
|
-
<
|
|
66
|
-
|
|
74
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
75
|
+
SETTING BACKCOLOR BLUE
|
|
76
|
+
SETTING HEIGHT 50
|
|
77
|
+
LABEL "THIS IS A TEST"
|
|
78
|
+
SETTING BACKCOLOR GREY
|
|
79
|
+
SETTING HEIGHT 2em
|
|
80
|
+
</code></pre>
|
|
81
|
+
<h3 id="margin">MARGIN</h3>
|
|
67
82
|
<p><strong>Sets the widget margin</strong></p>
|
|
68
|
-
<p>MARGIN supports <a href="https://www.w3schools.com/cssref/css_units.php"
|
|
83
|
+
<p>MARGIN supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p>
|
|
69
84
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Size in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table>
|
|
70
85
|
<p>Example Usage:</p>
|
|
71
|
-
<
|
|
72
|
-
|
|
86
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
87
|
+
SETTING BACKCOLOR BLUE
|
|
88
|
+
LABEL "THIS IS A TEST"
|
|
89
|
+
SETTING BACKCOLOR GREY
|
|
90
|
+
SETTING MARGIN 10
|
|
91
|
+
LABEL "THIS IS A TEST"
|
|
92
|
+
SETTING BACKCOLOR GREEN
|
|
93
|
+
</code></pre>
|
|
94
|
+
<h3 id="padding">PADDING</h3>
|
|
73
95
|
<p><strong>Sets the widget padding</strong></p>
|
|
74
|
-
<p>PADDING supports <a href="https://www.w3schools.com/cssref/css_units.php"
|
|
96
|
+
<p>PADDING supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p>
|
|
75
97
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Size in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table>
|
|
76
98
|
<p>Example Usage:</p>
|
|
77
|
-
<
|
|
78
|
-
|
|
99
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
100
|
+
SETTING BACKCOLOR BLUE
|
|
101
|
+
LABEL "THIS IS A TEST"
|
|
102
|
+
SETTING BACKCOLOR GREY
|
|
103
|
+
SETTING PADDING 10
|
|
104
|
+
LABEL "THIS IS A TEST"
|
|
105
|
+
SETTING BACKCOLOR GREEN
|
|
106
|
+
</code></pre>
|
|
107
|
+
<h3 id="backcolor">BACKCOLOR</h3>
|
|
79
108
|
<p><strong>The BACKCOLOR setting sets the background color for a widget</strong></p>
|
|
80
109
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table>
|
|
81
110
|
<p>Example Usage:</p>
|
|
82
|
-
<
|
|
83
|
-
|
|
111
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
112
|
+
SETTING BACKCOLOR red
|
|
113
|
+
LABEL "THIS IS A TEST"
|
|
114
|
+
SETTING BACKCOLOR 155 50 155
|
|
115
|
+
</code></pre>
|
|
116
|
+
<h3 id="textcolor">TEXTCOLOR</h3>
|
|
84
117
|
<p><strong>The TEXTCOLOR setting sets the text color for a widget</strong></p>
|
|
85
118
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table>
|
|
86
119
|
<p>Example Usage:</p>
|
|
87
|
-
<
|
|
88
|
-
|
|
120
|
+
<pre><code class="language-ruby">LABEL "THIS IS A TEST"
|
|
121
|
+
SETTING TEXTCOLOR red
|
|
122
|
+
LABEL "THIS IS A TEST"
|
|
123
|
+
SETTING TEXTCOLOR 155 50 155
|
|
124
|
+
</code></pre>
|
|
125
|
+
<h3 id="bordercolor">BORDERCOLOR</h3>
|
|
89
126
|
<p><strong>The BORDERCOLOR setting sets the border color for a layout widget</strong></p>
|
|
90
127
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table>
|
|
91
128
|
<p>Example Usage:</p>
|
|
92
|
-
<
|
|
93
|
-
|
|
129
|
+
<pre><code class="language-ruby">HORIZONTAL
|
|
130
|
+
LABEL "Label 1"
|
|
131
|
+
END
|
|
132
|
+
SETTING BORDERCOLOR red
|
|
133
|
+
VERTICAL
|
|
134
|
+
LABEL "Label 2"
|
|
135
|
+
END
|
|
136
|
+
SETTING BORDERCOLOR 155 50 155
|
|
137
|
+
</code></pre>
|
|
138
|
+
<h3 id="raw">RAW</h3>
|
|
94
139
|
<p><strong>Apply a raw CSS stylesheet key and value</strong></p>
|
|
95
140
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>CSS key like font-size, max-width, etc</td><td>True</td></tr><tr><td>Value</td><td>CSS Value</td><td>True</td></tr></tbody></table>
|
|
96
141
|
<p>Example Usage:</p>
|
|
97
|
-
<
|
|
98
|
-
|
|
142
|
+
<pre><code class="language-ruby">LABEL "Label 1"
|
|
143
|
+
SETTING RAW font-size 30px
|
|
144
|
+
</code></pre>
|
|
145
|
+
<h2 id="subsetting">SUBSETTING</h2>
|
|
99
146
|
<p><strong>Applies a widget subsetting to the previously defined widget</strong></p>
|
|
100
147
|
<p>Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL.</p>
|
|
101
148
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Subwidget Index</td><td>Index to the desired subwidget or 'ALL' to apply the setting to all the subwidgets of this composite widget.</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table>
|
|
102
149
|
<p>Example Usage:</p>
|
|
103
|
-
<
|
|
104
|
-
|
|
150
|
+
<pre><code class="language-ruby">VERTICALBOX
|
|
151
|
+
LABELVALUE INST HEALTH_STATUS TEMP1
|
|
152
|
+
SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
|
|
153
|
+
LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
|
|
154
|
+
SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green
|
|
155
|
+
END
|
|
156
|
+
</code></pre>
|
|
157
|
+
<h2 id="named_widget">NAMED_WIDGET</h2>
|
|
105
158
|
<p><strong>Name a widget to allow access to it via the getNamedWidget method</strong></p>
|
|
106
159
|
<p>To programatically access parts of a telemetry screen you need to name the widget. This is useful when creating screens with buttons that read values from other widgets.</p>
|
|
107
|
-
<
|
|
160
|
+
<admonition type="warning"><p>getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget</p></admonition>
|
|
108
161
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Name</td><td>The unique name applied to the following widget instance. Names must be unique per screen.</td><td>True</td></tr><tr><td>Widget Type</td><td>One of the widget types listed in Widget Descriptions</td><td>True</td></tr><tr><td>Widget Parameters</td><td>The unique parameters for the given widget type</td><td>True</td></tr></tbody></table>
|
|
109
162
|
<p>Example Usage:</p>
|
|
110
|
-
<
|
|
111
|
-
|
|
163
|
+
<pre><code class="language-ruby">NAMED_WIDGET DURATION TEXTFIELD
|
|
164
|
+
BUTTON "Push" "screen.getNamedWidget('DURATION').text()"
|
|
165
|
+
</code></pre>
|
|
166
|
+
<h2 id="layout-widgets">Layout Widgets</h2>
|
|
112
167
|
<hr>
|
|
113
168
|
<p>Layout widgets are used to position other widgets on the screen. For example, the HORIZONTAL layout widget places the widgets it encapsulates horizontally on the screen.</p>
|
|
114
|
-
<h3
|
|
169
|
+
<h3 id="vertical">VERTICAL</h3>
|
|
115
170
|
<p><strong>Places the widgets it encapsulates vertically</strong></p>
|
|
116
171
|
<p>The screen defaults to a vertical layout, so if no layout widgets are specified, all widgets will be automatically placed within a VERTICAL layout widget. The VERTICAL widget sizes itself to fit its contents.</p>
|
|
117
172
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
118
173
|
<p>Example Usage:</p>
|
|
119
|
-
<
|
|
120
|
-
|
|
174
|
+
<pre><code class="language-ruby">VERTICAL 5px
|
|
175
|
+
LABEL "TEST"
|
|
176
|
+
LABEL "SCREEN"
|
|
177
|
+
END
|
|
178
|
+
</code></pre>
|
|
179
|
+
<h3 id="verticalbox">VERTICALBOX</h3>
|
|
121
180
|
<p><strong>Places the widgets it encapsulates vertically inside a thin border</strong></p>
|
|
122
181
|
<p>The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally</p>
|
|
123
182
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Title</td><td>Text to place within the border to label the box</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
124
183
|
<p>Example Usage:</p>
|
|
125
|
-
<
|
|
126
|
-
|
|
184
|
+
<pre><code class="language-ruby">VERTICALBOX Info
|
|
185
|
+
LABEL "TEST"
|
|
186
|
+
LABEL "SCREEN"
|
|
187
|
+
END
|
|
188
|
+
</code></pre>
|
|
189
|
+
<h3 id="horizontal">HORIZONTAL</h3>
|
|
127
190
|
<p><strong>Places the widgets it encapsulates horizontally</strong></p>
|
|
128
191
|
<p>The HORIZONTAL widget sizes itself to fit its contents</p>
|
|
129
192
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
130
193
|
<p>Example Usage:</p>
|
|
131
|
-
<
|
|
132
|
-
|
|
194
|
+
<pre><code class="language-ruby">HORIZONTAL 100
|
|
195
|
+
LABEL "TEST"
|
|
196
|
+
LABEL "SCREEN"
|
|
197
|
+
END
|
|
198
|
+
</code></pre>
|
|
199
|
+
<h3 id="horizontalbox">HORIZONTALBOX</h3>
|
|
133
200
|
<p><strong>Places the widgets it encapsulates horizontally inside a thin border</strong></p>
|
|
134
201
|
<p>The HORIZONTALBOX widget sizes itself to fit its contents</p>
|
|
135
202
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Title</td><td>Text to place within the border to label the box</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
136
203
|
<p>Example Usage:</p>
|
|
137
|
-
<
|
|
138
|
-
|
|
204
|
+
<pre><code class="language-ruby">HORIZONTALBOX Info 10
|
|
205
|
+
LABEL "TEST"
|
|
206
|
+
LABEL "SCREEN"
|
|
207
|
+
END
|
|
208
|
+
</code></pre>
|
|
209
|
+
<h3 id="matrixbycolumns">MATRIXBYCOLUMNS</h3>
|
|
139
210
|
<p><strong>Places the widgets into a table-like matrix</strong></p>
|
|
140
211
|
<p>The MATRIXBYCOLUMNS widget sizes itself to fit its contents</p>
|
|
141
212
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Columns</td><td>The number of columns to create</td><td>True</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
142
213
|
<p>Example Usage:</p>
|
|
143
|
-
<
|
|
144
|
-
|
|
214
|
+
<pre><code class="language-ruby">MATRIXBYCOLUMNS 3 10
|
|
215
|
+
LABEL "COL 1"
|
|
216
|
+
LABEL "COL 2"
|
|
217
|
+
LABEL "COL 3"
|
|
218
|
+
LABEL "100"
|
|
219
|
+
LABEL "200"
|
|
220
|
+
LABEL "300"
|
|
221
|
+
END
|
|
222
|
+
</code></pre>
|
|
223
|
+
<h3 id="scrollwindow">SCROLLWINDOW</h3>
|
|
145
224
|
<p><strong>Places the widgets inside of it into a scrollable area</strong></p>
|
|
146
225
|
<p>The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained</p>
|
|
147
226
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Height</td><td>Maximum height of the scroll window in pixels (default = 200)</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table>
|
|
148
227
|
<p>Example Usage:</p>
|
|
149
|
-
<
|
|
150
|
-
|
|
228
|
+
<pre><code class="language-ruby">SCROLLWINDOW 100 10
|
|
229
|
+
VERTICAL
|
|
230
|
+
LABEL "100"
|
|
231
|
+
LABEL "200"
|
|
232
|
+
LABEL "300"
|
|
233
|
+
LABEL "400"
|
|
234
|
+
LABEL "500"
|
|
235
|
+
LABEL "600"
|
|
236
|
+
LABEL "700"
|
|
237
|
+
LABEL "800"
|
|
238
|
+
LABEL "900"
|
|
239
|
+
END
|
|
240
|
+
END
|
|
241
|
+
</code></pre>
|
|
242
|
+
<h3 id="tabbook">TABBOOK</h3>
|
|
151
243
|
<p><strong>Creates a tabbed area in which to place TABITEM widgets</strong></p>
|
|
152
|
-
<h3
|
|
244
|
+
<h3 id="tabitem">TABITEM</h3>
|
|
153
245
|
<p><strong>Creates a VERTICAL layout tab into which to place widgets</strong></p>
|
|
154
246
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Tab text</td><td>Text to diplay in the tab</td><td>True</td></tr></tbody></table>
|
|
155
247
|
<p>Example Usage:</p>
|
|
156
|
-
<
|
|
157
|
-
|
|
248
|
+
<pre><code class="language-ruby">TABBOOK
|
|
249
|
+
TABITEM "Tab 1"
|
|
250
|
+
LABEL "100"
|
|
251
|
+
LABEL "200"
|
|
252
|
+
END
|
|
253
|
+
TABITEM "Tab 2"
|
|
254
|
+
LABEL "300"
|
|
255
|
+
LABEL "400"
|
|
256
|
+
END
|
|
257
|
+
END
|
|
258
|
+
</code></pre>
|
|
259
|
+
<h3 id="iframe">IFRAME</h3>
|
|
158
260
|
<p><strong>Open external tools in an Iframe within OpenC3</strong></p>
|
|
159
261
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>URL</td><td>The path to the page to display in the iframe</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget</td><td>False</td></tr></tbody></table>
|
|
160
262
|
<p>Example Usage:</p>
|
|
161
|
-
<
|
|
162
|
-
|
|
263
|
+
<pre><code class="language-ruby">IFRAME https://openc3.com 900 450
|
|
264
|
+
</code></pre>
|
|
265
|
+
<h2 id="decoration-widgets">Decoration Widgets</h2>
|
|
163
266
|
<hr>
|
|
164
267
|
<p>Decoration widgets are used to enhance the appearance of the screen. They do not respond to input, nor does the output vary with telemetry.</p>
|
|
165
|
-
<h3
|
|
268
|
+
<h3 id="label">LABEL</h3>
|
|
166
269
|
<p><strong>Displays text on the screen</strong></p>
|
|
167
270
|
<p>Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget.</p>
|
|
168
271
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display on the label</td><td>True</td></tr></tbody></table>
|
|
169
272
|
<p>Example Usage:</p>
|
|
170
|
-
<
|
|
171
|
-
|
|
273
|
+
<pre><code class="language-ruby">LABEL "Note: This is only a warning"
|
|
274
|
+
</code></pre>
|
|
275
|
+
<h3 id="horizontalline">HORIZONTALLINE</h3>
|
|
172
276
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Displays a horizontal line on the screen that can be used as a separator</strong><p></p>
|
|
173
277
|
<p>Example Usage:</p>
|
|
174
|
-
<
|
|
175
|
-
|
|
278
|
+
<pre><code class="language-ruby">LABEL Over
|
|
279
|
+
HORIZONTALLINE
|
|
280
|
+
LABEL Under
|
|
281
|
+
</code></pre>
|
|
282
|
+
<h3 id="sectionheader">SECTIONHEADER</h3>
|
|
176
283
|
<p><strong>DEPRECATED - Displays a label that is underlined with a horizontal line</strong></p>
|
|
177
284
|
<p>Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER</p>
|
|
178
285
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display</td><td>True</td></tr></tbody></table>
|
|
179
|
-
<h3
|
|
286
|
+
<h3 id="title">TITLE</h3>
|
|
180
287
|
<p><strong>Displays a large centered title on the screen</strong></p>
|
|
181
288
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display</td><td>True</td></tr></tbody></table>
|
|
182
289
|
<p>Example Usage:</p>
|
|
183
|
-
<
|
|
184
|
-
|
|
290
|
+
<pre><code class="language-ruby">TITLE "Title"
|
|
291
|
+
HORIZONTALLINE
|
|
292
|
+
LABEL "Label"
|
|
293
|
+
</code></pre>
|
|
294
|
+
<h3 id="spacer">SPACER</h3>
|
|
185
295
|
<p><strong>Places a fixed size spacer in between widgets</strong></p>
|
|
186
296
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width of the spacer in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height of the spacer in pixels</td><td>True</td></tr></tbody></table>
|
|
187
297
|
<p>Example Usage:</p>
|
|
188
|
-
<
|
|
189
|
-
|
|
298
|
+
<pre><code class="language-ruby">VERTICAL 3
|
|
299
|
+
LABEL "Spacer below"
|
|
300
|
+
SPACER 0 100
|
|
301
|
+
LABEL "Spacer above"
|
|
302
|
+
END
|
|
303
|
+
</code></pre>
|
|
304
|
+
<h2 id="telemetry-widgets">Telemetry Widgets</h2>
|
|
190
305
|
<hr>
|
|
191
306
|
<p>Telemetry widgets are used to display telemetry values. The first parameters to each of these widgets is a telemetry mnemonic. Depending on the type and purpose of the telemetry item, the screen designer may select from a wide selection of widgets to display the value in the most useful format.</p>
|
|
192
|
-
<h3
|
|
307
|
+
<h3 id="array">ARRAY</h3>
|
|
193
308
|
<p><strong>Displays ARRAY data organized into rows and space separated</strong></p>
|
|
194
309
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget (default = 100)</td><td>False</td></tr><tr><td>Format string</td><td>Format string applied to each array item (default = nil)</td><td>False</td></tr><tr><td>Items per row</td><td>Number of array items per row (default = 4)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table>
|
|
195
310
|
<p>Example Usage:</p>
|
|
196
|
-
<
|
|
197
|
-
|
|
311
|
+
<pre><code class="language-ruby">ARRAY INST HEALTH_STATUS ARY 250 80 "0x%x" 6 FORMATTED
|
|
312
|
+
ARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS
|
|
313
|
+
</code></pre>
|
|
314
|
+
<h3 id="block">BLOCK</h3>
|
|
198
315
|
<p><strong>Displays BLOCK data organized into rows and space separated</strong></p>
|
|
199
316
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget (default = 100)</td><td>False</td></tr><tr><td>Format string</td><td>Format string applied to each array item (default = nil)</td><td>False</td></tr><tr><td>Bytes per word</td><td>Number of bytes per word (default = 4)</td><td>False</td></tr><tr><td>Words per row</td><td>Number of words per row (default = 4</td><td>False</td></tr><tr><td>Address format</td><td>Format for the address printed at the beginning of each line (default = nil which means do not print an address)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table>
|
|
200
317
|
<p>Example Usage:</p>
|
|
201
|
-
<
|
|
202
|
-
|
|
318
|
+
<pre><code class="language-ruby">BLOCK INST IMAGE IMAGE 400 130 "%02X" 4 4 "0x%08X:"
|
|
319
|
+
</code></pre>
|
|
320
|
+
<h3 id="formatvalue">FORMATVALUE</h3>
|
|
203
321
|
<p><strong>Displays a box with a formatted value</strong></p>
|
|
204
322
|
<p>Data is formatted by the specified string rather than by a format string given in the telemetry definition files. The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits).</p>
|
|
205
323
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Format string</td><td>Printf style format string to apply to the telemetry item</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
206
324
|
<p>Example Usage:</p>
|
|
207
|
-
<
|
|
208
|
-
|
|
325
|
+
<pre><code class="language-ruby">FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20
|
|
326
|
+
</code></pre>
|
|
327
|
+
<h3 id="labelled">LABELLED</h3>
|
|
209
328
|
<p><strong>Displays a LABEL followed by a LED</strong></p>
|
|
210
329
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Height</td><td>Height of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Justification</td><td>How to justify the label and LED together. The default of 'SPLIT' aligns the label to the left and the LED to the right with any additional space going between them. 'CENTER' pushes the label and LED together with any additional space to the left and right. 'LEFT' or 'RIGHT' pushes them to the respective side with the space going on the opposite.<br><br>Valid Values: <span class="values">SPLIT, CENTER, LEFT, RIGHT</span></td><td>False</td></tr></tbody></table>
|
|
211
330
|
<p>Example Usage:</p>
|
|
212
|
-
<
|
|
331
|
+
<pre><code class="language-ruby">LABELLED INST PARAMS VALUE1
|
|
332
|
+
SETTING LED_COLOR GOOD GREEN
|
|
333
|
+
SETTING LED_COLOR BAD RED
|
|
334
|
+
</code></pre>
|
|
213
335
|
<p>The following settings apply to LABELLED. They are applied using the SETTING keyword.</p>
|
|
214
|
-
<h4
|
|
336
|
+
<h4 id="led_color">LED_COLOR</h4>
|
|
215
337
|
<p><strong>Map a state or value to a color</strong></p>
|
|
216
338
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value. ANY used to match any value or state not declared.</td><td>True</td></tr><tr><td>LED color</td><td>Color of the LED</td><td>True</td></tr></tbody></table>
|
|
217
|
-
<h3
|
|
339
|
+
<h3 id="labelprogressbar">LABELPROGRESSBAR</h3>
|
|
218
340
|
<p><strong>Displays a LABEL with the item name followed by a PROGRESSBAR</strong></p>
|
|
219
341
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Scale factor</td><td>Value to multiply the telemetry item by before displaying in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.</td><td>False</td></tr><tr><td>Width</td><td>Width of the progress bar (default = 80 pixels</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table>
|
|
220
342
|
<p>Example Usage:</p>
|
|
221
|
-
<
|
|
222
|
-
|
|
343
|
+
<pre><code class="language-ruby">LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW
|
|
344
|
+
LABELPROGRESSBAR INST ADCS POSPROGRESS
|
|
345
|
+
</code></pre>
|
|
346
|
+
<h3 id="labelvalue">LABELVALUE</h3>
|
|
223
347
|
<p><strong>Displays a LABEL with the item name followed by a VALUE</strong></p>
|
|
224
348
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
225
349
|
<p>Example Usage:</p>
|
|
226
|
-
<
|
|
227
|
-
|
|
350
|
+
<pre><code class="language-ruby">LABELVALUE INST LATEST TIMESEC CONVERTED 18
|
|
351
|
+
LABELVALUE INST LATEST COLLECT_TYPE
|
|
352
|
+
</code></pre>
|
|
353
|
+
<h3 id="labelvaluedesc">LABELVALUEDESC</h3>
|
|
228
354
|
<p><strong>Displays a LABEL with the items description followed by a VALUE</strong></p>
|
|
229
355
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Description</td><td>The description to display in the label (default is to display the description text associated with the telemetry item)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
230
356
|
<p>Example Usage:</p>
|
|
231
|
-
<
|
|
232
|
-
|
|
357
|
+
<pre><code class="language-ruby">LABELVALUEDESC INST HEALTH_STATUS TEMP1 "Temperature number 1" RAW 18
|
|
358
|
+
LABELVALUEDESC INST HEALTH_STATUS COLLECT_TYPE
|
|
359
|
+
</code></pre>
|
|
360
|
+
<h3 id="labelvaluelimitsbar">LABELVALUELIMITSBAR</h3>
|
|
233
361
|
<p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets</strong></p>
|
|
234
362
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
235
|
-
<h3
|
|
363
|
+
<h3 id="labelvaluelimitscolumn">LABELVALUELIMITSCOLUMN</h3>
|
|
236
364
|
<p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets</strong></p>
|
|
237
365
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
238
366
|
<p>Example Usage:</p>
|
|
239
|
-
<
|
|
240
|
-
|
|
367
|
+
<pre><code class="language-ruby">LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18
|
|
368
|
+
LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
|
369
|
+
</code></pre>
|
|
370
|
+
<h3 id="labelvaluerangebar">LABELVALUERANGEBAR</h3>
|
|
241
371
|
<p><strong>Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets</strong></p>
|
|
242
372
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table>
|
|
243
373
|
<p>Example Usage:</p>
|
|
244
|
-
<
|
|
245
|
-
|
|
374
|
+
<pre><code class="language-ruby">LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
|
375
|
+
LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120
|
|
376
|
+
</code></pre>
|
|
377
|
+
<h3 id="led">LED</h3>
|
|
246
378
|
<p><strong>Displays a LED which changes color based on telemetry values</strong></p>
|
|
247
379
|
<p>By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.</p>
|
|
248
380
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Height</td><td>Height of the LED circle (default = 15)</td><td>False</td></tr></tbody></table>
|
|
249
381
|
<p>Example Usage:</p>
|
|
250
|
-
<
|
|
382
|
+
<pre><code class="language-ruby">LED INST PARAMS VALUE5 RAW 25 20 # Ellipse
|
|
383
|
+
SETTING LED_COLOR 0 GREEN
|
|
384
|
+
SETTING LED_COLOR 1 RED
|
|
385
|
+
SETTING LED_COLOR ANY YELLOW
|
|
386
|
+
</code></pre>
|
|
251
387
|
<p>The following settings apply to LED. They are applied using the SETTING keyword.</p>
|
|
252
|
-
<h4
|
|
388
|
+
<h4 id="led_color-1">LED_COLOR</h4>
|
|
253
389
|
<p><strong>Map a state or value to a color</strong></p>
|
|
254
390
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value. ANY used to match any value or state not declared.</td><td>True</td></tr><tr><td>LED color</td><td>Color of the LED</td><td>True</td></tr></tbody></table>
|
|
255
|
-
<h3
|
|
391
|
+
<h3 id="limitsbar">LIMITSBAR</h3>
|
|
256
392
|
<p><strong>Displays an item's current value within its colored limits horizontally</strong></p>
|
|
257
393
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table>
|
|
258
394
|
<p>Example Usage:</p>
|
|
259
|
-
<
|
|
260
|
-
|
|
395
|
+
<pre><code class="language-ruby">LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50
|
|
396
|
+
LIMITSBAR INST HEALTH_STATUS TEMP1
|
|
397
|
+
</code></pre>
|
|
398
|
+
<h3 id="limitscolumn">LIMITSCOLUMN</h3>
|
|
261
399
|
<p><strong>Displays an item's current value within its colored limits vertically</strong></p>
|
|
262
400
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table>
|
|
263
401
|
<p>Example Usage:</p>
|
|
264
|
-
<
|
|
265
|
-
|
|
402
|
+
<pre><code class="language-ruby">LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200
|
|
403
|
+
LIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
|
404
|
+
</code></pre>
|
|
405
|
+
<h3 id="limitscolor">LIMITSCOLOR</h3>
|
|
266
406
|
<p><strong>Displays a circle depicting the limits color of an item</strong></p>
|
|
267
407
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Radius</td><td>Radius of the circle (default is 10)</td><td>False</td></tr><tr><td>Full Item Name</td><td>Show the full item name (default is false)</td><td>False</td></tr></tbody></table>
|
|
268
408
|
<p>Example Usage:</p>
|
|
269
|
-
<
|
|
270
|
-
|
|
409
|
+
<pre><code class="language-ruby">LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE
|
|
410
|
+
LIMITSCOLOR INST HEALTH_STATUS TEMP1
|
|
411
|
+
</code></pre>
|
|
412
|
+
<h3 id="valuelimitsbar">VALUELIMITSBAR</h3>
|
|
271
413
|
<p><strong>Displays an item VALUE followed by LIMITSBAR</strong></p>
|
|
272
414
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
273
415
|
<p>Example Usage:</p>
|
|
274
|
-
<
|
|
275
|
-
|
|
416
|
+
<pre><code class="language-ruby">VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18
|
|
417
|
+
VALUELIMITSBAR INST HEALTH_STATUS TEMP1
|
|
418
|
+
</code></pre>
|
|
419
|
+
<h3 id="valuelimitscolumn">VALUELIMITSCOLUMN</h3>
|
|
276
420
|
<p><strong>Displays an item VALUE followed by LIMITSCOLUMN</strong></p>
|
|
277
421
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 8)</td><td>False</td></tr></tbody></table>
|
|
278
422
|
<p>Example Usage:</p>
|
|
279
|
-
<
|
|
280
|
-
|
|
423
|
+
<pre><code class="language-ruby">VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18
|
|
424
|
+
VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
|
425
|
+
</code></pre>
|
|
426
|
+
<h3 id="valuerangebar">VALUERANGEBAR</h3>
|
|
281
427
|
<p><strong>Displays an item VALUE followed by RANGEBAR</strong></p>
|
|
282
428
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table>
|
|
283
429
|
<p>Example Usage:</p>
|
|
284
|
-
<
|
|
285
|
-
|
|
430
|
+
<pre><code class="language-ruby">VALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
|
431
|
+
VALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120
|
|
432
|
+
</code></pre>
|
|
433
|
+
<h3 id="linegraph">LINEGRAPH</h3>
|
|
286
434
|
<p><strong>Displays a line graph of a telemetry item</strong></p>
|
|
287
435
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
288
436
|
<p>Example Usage:</p>
|
|
289
|
-
<
|
|
437
|
+
<pre><code class="language-ruby">LINEGRAPH INST HEALTH_STATUS TEMP1
|
|
438
|
+
SETTING ITEM INST ADCS Q1 # Add additional item to graph
|
|
439
|
+
LINEGRAPH INST HEALTH_STATUS TEMP2 RAW
|
|
440
|
+
LINEGRAPH INST HEALTH_STATUS TEMP3 CONVERTED REDUCED_MINUTE MIN
|
|
441
|
+
SETTING SIZE 600 500 # width height
|
|
442
|
+
SETTING HISTORY 1h # load 1 hour of data into graph
|
|
443
|
+
LINEGRAPH INST HEALTH_STATUS TEMP4
|
|
444
|
+
SETTING HISTORY 30m # load 30 minutes of data into graph
|
|
445
|
+
</code></pre>
|
|
290
446
|
<p>The following settings apply to LINEGRAPH. They are applied using the SETTING keyword.</p>
|
|
291
|
-
<h4
|
|
447
|
+
<h4 id="item">ITEM</h4>
|
|
292
448
|
<p><strong>Add a telemetry item to the graph</strong></p>
|
|
293
449
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
294
|
-
<h4
|
|
450
|
+
<h4 id="starttime">STARTTIME</h4>
|
|
295
451
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p>
|
|
296
452
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted 'YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->'</td><td>True</td></tr></tbody></table>
|
|
297
|
-
<h4
|
|
453
|
+
<h4 id="history">HISTORY</h4>
|
|
298
454
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p>
|
|
299
455
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table>
|
|
300
|
-
<h4
|
|
456
|
+
<h4 id="secondsgraphed">SECONDSGRAPHED</h4>
|
|
301
457
|
<p><strong>Display the specified number of seconds in the graph</strong></p>
|
|
302
458
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table>
|
|
303
|
-
<h4
|
|
459
|
+
<h4 id="pointssaved">POINTSSAVED</h4>
|
|
304
460
|
<p><strong>Save the number of seconds in graph memory</strong></p>
|
|
305
461
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table>
|
|
306
|
-
<h4
|
|
462
|
+
<h4 id="pointsgraphed">POINTSGRAPHED</h4>
|
|
307
463
|
<p><strong>Number of points to display on the graph</strong></p>
|
|
308
464
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table>
|
|
309
|
-
<h4
|
|
465
|
+
<h4 id="size">SIZE</h4>
|
|
310
466
|
<p><strong>Size of the graph</strong></p>
|
|
311
467
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table>
|
|
312
|
-
<h3
|
|
468
|
+
<h3 id="sparkline">SPARKLINE</h3>
|
|
313
469
|
<p><strong>Displays a sparkline graph (no cursor, scale or legend) of a telemetry item</strong></p>
|
|
314
470
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
315
471
|
<p>Example Usage:</p>
|
|
316
|
-
<
|
|
472
|
+
<pre><code class="language-ruby">SPARKLINE INST HEALTH_STATUS TEMP1
|
|
473
|
+
SETTING SIZE 400 50
|
|
474
|
+
SETTING HISTORY 30s # Add 30 seconds of data into graph
|
|
475
|
+
</code></pre>
|
|
317
476
|
<p>The following settings apply to SPARKLINE. They are applied using the SETTING keyword.</p>
|
|
318
|
-
<h4
|
|
477
|
+
<h4 id="item-1">ITEM</h4>
|
|
319
478
|
<p><strong>Add a telemetry item to the graph</strong></p>
|
|
320
479
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
321
|
-
<h4
|
|
480
|
+
<h4 id="starttime-1">STARTTIME</h4>
|
|
322
481
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p>
|
|
323
482
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted 'YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->'</td><td>True</td></tr></tbody></table>
|
|
324
|
-
<h4
|
|
483
|
+
<h4 id="history-1">HISTORY</h4>
|
|
325
484
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p>
|
|
326
485
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table>
|
|
327
|
-
<h4
|
|
486
|
+
<h4 id="secondsgraphed-1">SECONDSGRAPHED</h4>
|
|
328
487
|
<p><strong>Display the specified number of seconds in the graph</strong></p>
|
|
329
488
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table>
|
|
330
|
-
<h4
|
|
489
|
+
<h4 id="pointssaved-1">POINTSSAVED</h4>
|
|
331
490
|
<p><strong>Save the number of seconds in graph memory</strong></p>
|
|
332
491
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table>
|
|
333
|
-
<h4
|
|
492
|
+
<h4 id="pointsgraphed-1">POINTSGRAPHED</h4>
|
|
334
493
|
<p><strong>Number of points to display on the graph</strong></p>
|
|
335
494
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table>
|
|
336
|
-
<h4
|
|
495
|
+
<h4 id="size-1">SIZE</h4>
|
|
337
496
|
<p><strong>Size of the graph</strong></p>
|
|
338
497
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table>
|
|
339
|
-
<h3
|
|
498
|
+
<h3 id="labelsparkline">LABELSPARKLINE</h3>
|
|
340
499
|
<p><strong>Displays a LABEL with the item name followed by a SPARKLINE</strong></p>
|
|
341
500
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
342
501
|
<p>Example Usage:</p>
|
|
343
|
-
<
|
|
502
|
+
<pre><code class="language-ruby">LABELSPARKLINE INST HEALTH_STATUS TEMP1
|
|
503
|
+
SETTING HISTORY 5m # Add 5 minutes of data into graph
|
|
504
|
+
</code></pre>
|
|
344
505
|
<p>The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword.</p>
|
|
345
|
-
<h4
|
|
506
|
+
<h4 id="item-2">ITEM</h4>
|
|
346
507
|
<p><strong>Add a telemetry item to the graph</strong></p>
|
|
347
508
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table>
|
|
348
|
-
<h4
|
|
509
|
+
<h4 id="starttime-2">STARTTIME</h4>
|
|
349
510
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p>
|
|
350
511
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted 'YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->'</td><td>True</td></tr></tbody></table>
|
|
351
|
-
<h4
|
|
512
|
+
<h4 id="history-2">HISTORY</h4>
|
|
352
513
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p>
|
|
353
514
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table>
|
|
354
|
-
<h4
|
|
515
|
+
<h4 id="secondsgraphed-2">SECONDSGRAPHED</h4>
|
|
355
516
|
<p><strong>Display the specified number of seconds in the graph</strong></p>
|
|
356
517
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table>
|
|
357
|
-
<h4
|
|
518
|
+
<h4 id="pointssaved-2">POINTSSAVED</h4>
|
|
358
519
|
<p><strong>Save the number of seconds in graph memory</strong></p>
|
|
359
520
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table>
|
|
360
|
-
<h4
|
|
521
|
+
<h4 id="pointsgraphed-2">POINTSGRAPHED</h4>
|
|
361
522
|
<p><strong>Number of points to display on the graph</strong></p>
|
|
362
523
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table>
|
|
363
|
-
<h4
|
|
524
|
+
<h4 id="size-2">SIZE</h4>
|
|
364
525
|
<p><strong>Size of the graph</strong></p>
|
|
365
526
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table>
|
|
366
|
-
<h3
|
|
527
|
+
<h3 id="imageviewer">IMAGEVIEWER</h3>
|
|
367
528
|
<p><strong>Display a base64 image from a TLM packet</strong></p>
|
|
368
529
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Format</td><td>The image format of the base64 data (e.g. jpg, png, etc)</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget</td><td>False</td></tr></tbody></table>
|
|
369
530
|
<p>Example Usage:</p>
|
|
370
|
-
<
|
|
371
|
-
|
|
531
|
+
<pre><code class="language-ruby">IMAGEVIEWER INST IMAGE IMAGE jpg
|
|
532
|
+
</code></pre>
|
|
533
|
+
<h3 id="progressbar">PROGRESSBAR</h3>
|
|
372
534
|
<p><strong>Displays a progress bar that is useful for displaying percentages</strong></p>
|
|
373
535
|
<p>Example Usage:</p>
|
|
374
|
-
<
|
|
375
|
-
|
|
536
|
+
<pre><code class="language-ruby">PROGRESSBAR INST ADCS POSPROGRESS 0.5 200
|
|
537
|
+
PROGRESSBAR INST ADCS POSPROGRESS
|
|
538
|
+
</code></pre>
|
|
539
|
+
<h3 id="rangebar">RANGEBAR</h3>
|
|
376
540
|
<p><strong>Displays a custom range bar displaying the item value</strong></p>
|
|
377
541
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 100)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table>
|
|
378
542
|
<p>Example Usage:</p>
|
|
379
|
-
<
|
|
380
|
-
|
|
543
|
+
<pre><code class="language-ruby">RANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50
|
|
544
|
+
RANGEBAR INST HEALTH_STATUS TEMP1 -100 100
|
|
545
|
+
</code></pre>
|
|
546
|
+
<h3 id="textbox">TEXTBOX</h3>
|
|
381
547
|
<p><strong>Provides a large box for multiline text</strong></p>
|
|
382
548
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the textbox in px (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the textbox in px (default = 200)</td><td>False</td></tr></tbody></table>
|
|
383
549
|
<p>Example Usage:</p>
|
|
384
|
-
<
|
|
385
|
-
|
|
550
|
+
<pre><code class="language-ruby">TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70
|
|
551
|
+
TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED
|
|
552
|
+
</code></pre>
|
|
553
|
+
<h3 id="value">VALUE</h3>
|
|
386
554
|
<p><strong>Displays a box with a telemetry item value</strong></p>
|
|
387
555
|
<p>The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits).</p>
|
|
388
556
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table>
|
|
389
557
|
<p>Example Usage:</p>
|
|
390
|
-
<
|
|
391
|
-
|
|
558
|
+
<pre><code class="language-ruby">VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18
|
|
559
|
+
VALUE INST HEALTH_STATUS TEMP1
|
|
560
|
+
</code></pre>
|
|
561
|
+
<h2 id="interactive-widgets">Interactive Widgets</h2>
|
|
392
562
|
<hr>
|
|
393
563
|
<p>Interactive widgets are used to gather input from the user. Unlike all other widgets, which only output some graphical representation, interactive widgets permit input either from the keyboard or mouse.</p>
|
|
394
|
-
<h3
|
|
564
|
+
<h3 id="button">BUTTON</h3>
|
|
395
565
|
<p><strong>Displays a rectangular clickable button</strong></p>
|
|
396
566
|
<p>Upon clicking, the button executes the Ruby code assigned. Buttons
|
|
397
567
|
can be used to send commands and perform other tasks. If you want your button
|
|
398
568
|
to use values from other widgets, define them as named widgets and read their
|
|
399
569
|
values using the <code>screen.getNamedWidget("WIDGET_NAME").text()</code> method.
|
|
400
570
|
See the example in CHECKBUTTON.</p>
|
|
401
|
-
<h2
|
|
571
|
+
<h2 id="button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens">Button code can get rather complex so remember to use string concatenation
|
|
402
572
|
to make things more readable. If you use <code>+</code> newlines are inserted automatically
|
|
403
573
|
during string concatenation. If you use `---
|
|
404
574
|
sidebar_position: 9
|
|
405
|
-
title: Screens
|
|
575
|
+
title: Screens</h2>
|
|
406
576
|
<p>This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p>
|
|
407
577
|
<div style="clear:both"></div>
|
|
408
|
-
<h2
|
|
578
|
+
<h2 id="definitions-1">Definitions</h2>
|
|
409
579
|
<table><thead><tr><th>Name</th><th>Definition</th></tr></thead><tbody><tr><td>Widget</td><td>A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task.</td></tr><tr><td>Screen</td><td>A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion.</td></tr><tr><td>Screen Definition File</td><td>A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them.</td></tr></tbody></table>
|
|
410
|
-
<h2
|
|
580
|
+
<h2 id="telemetry-screen-definition-files-1">Telemetry Screen Definition Files</h2>
|
|
411
581
|
<p>Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target's screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase.</p>
|
|
412
|
-
<h2
|
|
582
|
+
<h2 id="new-widgets-1">New Widgets</h2>
|
|
413
583
|
<p>When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide.</p>
|
|
414
|
-
<h1>Screen Keywords</h1>
|
|
584
|
+
<h1 id="screen-keywords-1">Screen Keywords</h1>
|
|
415
585
|
<p>you'll need to separate lines with a
|
|
416
586
|
single semicolon <code>;</code>. COSMOS uses double semicolon <code>;;</code> to indicate lines should
|
|
417
587
|
be evaluated separately. Note that all OpenC3 commands (using api.cmd) must be
|
|
@@ -427,97 +597,185 @@ the name of the script, whether to open the script in the foreground of Script R
|
|
|
427
597
|
environment variables. For example: <code>runScript('INST/procedures/script.rb', false, {'VAR': 'VALUE'})</code></p>
|
|
428
598
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Button Text</td><td>Text displayed on the button</td><td>True</td></tr><tr><td>Button Code</td><td>Javascript code to execute when the button is pressed</td><td>True</td></tr></tbody></table>
|
|
429
599
|
<p>Example Usage:</p>
|
|
430
|
-
<
|
|
431
|
-
|
|
600
|
+
<pre><code class="language-ruby">BUTTON 'Start Collect' 'api.cmd("INST COLLECT with TYPE NORMAL, DURATION 5")'
|
|
601
|
+
BUTTON 'Run Checks' 'runScript("INST/procedures/checks.rb")'
|
|
602
|
+
# More complex example with background checkbox and env vars
|
|
603
|
+
NAMED_WIDGET SCRIPTNAME COMBOBOX collect.rb checks.rb
|
|
604
|
+
NAMED_WIDGET BG CHECKBUTTON 'Background'
|
|
605
|
+
BUTTON 'Run Script' "var script=screen.getNamedWidget('SCRIPTNAME').text();" \
|
|
606
|
+
# Set an environment variable to be used by the script as ENV['TYPE']
|
|
607
|
+
"var env = {}; env['TYPE'] = 'TEST';" \
|
|
608
|
+
"runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked(), env)"
|
|
609
|
+
</code></pre>
|
|
610
|
+
<h3 id="checkbutton">CHECKBUTTON</h3>
|
|
432
611
|
<p><strong>Displays a check box</strong></p>
|
|
433
612
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
434
613
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Checkbox Text</td><td>Text displayed next to the checkbox</td><td>True</td></tr></tbody></table>
|
|
435
614
|
<p>Example Usage:</p>
|
|
436
|
-
<
|
|
437
|
-
|
|
615
|
+
<pre><code class="language-ruby">NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks'
|
|
616
|
+
BUTTON 'Send' 'screen.getNamedWidget("CHECK").checked() ? ' \
|
|
617
|
+
'api.cmd_no_hazardous_check("INST CLEAR") : api.cmd("INST CLEAR")'
|
|
618
|
+
</code></pre>
|
|
619
|
+
<h3 id="combobox">COMBOBOX</h3>
|
|
438
620
|
<p><strong>Displays a drop down list of text items</strong></p>
|
|
439
621
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
440
622
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Option Text 1</td><td>Text to display in the selection drop down</td><td>True</td></tr><tr><td>Option Text n</td><td>Text to display in the selection drop down</td><td>False</td></tr></tbody></table>
|
|
441
623
|
<p>Example Usage:</p>
|
|
442
|
-
<
|
|
443
|
-
|
|
624
|
+
<pre><code class="language-ruby">BUTTON 'Start Collect' 'var type = screen.getNamedWidget("COLLECT_TYPE").text();' +
|
|
625
|
+
'api.cmd("INST COLLECT with TYPE "+type+", DURATION 10.0")'
|
|
626
|
+
NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL
|
|
627
|
+
</code></pre>
|
|
628
|
+
<h3 id="radiogroup">RADIOGROUP</h3>
|
|
444
629
|
<p><strong>Creates a group of RADIOBUTTONs</strong></p>
|
|
445
630
|
<p>RADIOBUTTONs must be part of a group to enable selection logic</p>
|
|
446
631
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Initial selected button</td><td>Selects a radio button at initialization (0-based)</td><td>False</td></tr></tbody></table>
|
|
447
|
-
<h3
|
|
632
|
+
<h3 id="radiobutton">RADIOBUTTON</h3>
|
|
448
633
|
<p><strong>Displays a radio button and text</strong></p>
|
|
449
634
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET. It must be contained by a RADIOGROUP to enable typical selection of a single RADIOBUTTON.</p>
|
|
450
635
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display next to the radio button</td><td>True</td></tr></tbody></table>
|
|
451
636
|
<p>Example Usage:</p>
|
|
452
|
-
<
|
|
453
|
-
|
|
637
|
+
<pre><code class="language-ruby">NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index
|
|
638
|
+
RADIOBUTTON 'Abort'
|
|
639
|
+
RADIOBUTTON 'Clear'
|
|
640
|
+
END
|
|
641
|
+
BUTTON 'Send' "screen.getNamedWidget('GROUP').selected() === 0 ? " +
|
|
642
|
+
"api.cmd('INST ABORT') : api.cmd('INST CLEAR')"
|
|
643
|
+
</code></pre>
|
|
644
|
+
<h3 id="textfield">TEXTFIELD</h3>
|
|
454
645
|
<p><strong>Displays a rectangular box where the user can enter text</strong></p>
|
|
455
646
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Characters</td><td>Width of the text field in characters (default = 12)</td><td>False</td></tr><tr><td>Text</td><td>Default text to put in the text field (default is blank)</td><td>False</td></tr></tbody></table>
|
|
456
647
|
<p>Example Usage:</p>
|
|
457
|
-
<
|
|
458
|
-
|
|
648
|
+
<pre><code class="language-ruby">NAMED_WIDGET DURATION TEXTFIELD 12 "10.0"
|
|
649
|
+
BUTTON 'Start Collect' 'var dur = screen.getNamedWidget("DURATION").text();' +
|
|
650
|
+
'api.cmd("INST COLLECT with TYPE NORMAL, DURATION "+dur+"")'
|
|
651
|
+
</code></pre>
|
|
652
|
+
<h2 id="canvas-widgets">Canvas Widgets</h2>
|
|
459
653
|
<hr>
|
|
460
654
|
<p>Canvas Widgets are used to draw custom displays into telemetry screens. The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.</p>
|
|
461
|
-
<h3
|
|
655
|
+
<h3 id="canvas">CANVAS</h3>
|
|
462
656
|
<p><strong>Layout widget for the other canvas widgets</strong></p>
|
|
463
657
|
<p>All canvas widgets must be enclosed within a CANVAS widget.</p>
|
|
464
|
-
<
|
|
658
|
+
<admonition type="warning"><p>The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.</p></admonition>
|
|
465
659
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width of the canvas</td><td>True</td></tr><tr><td>Height</td><td>Height of the canvas</td><td>True</td></tr></tbody></table>
|
|
466
|
-
<h3
|
|
660
|
+
<h3 id="canvaslabel">CANVASLABEL</h3>
|
|
467
661
|
<p><strong>Draws text onto the canvas</strong></p>
|
|
468
662
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>X Position</td><td>X position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Text</td><td>Text to draw onto the canvas</td><td>True</td></tr><tr><td>Font Size</td><td>Font size of the text (Default = 12)</td><td>False</td></tr><tr><td>Color</td><td>Color of the text</td><td>False</td></tr></tbody></table>
|
|
469
663
|
<p>Example Usage:</p>
|
|
470
|
-
<
|
|
471
|
-
|
|
664
|
+
<pre><code class="language-ruby">CANVAS 100 100
|
|
665
|
+
CANVASLABEL 5 34 "Label1" 24 red
|
|
666
|
+
CANVASLABEL 5 70 "Label2" 18 blue
|
|
667
|
+
END
|
|
668
|
+
</code></pre>
|
|
669
|
+
<h3 id="canvaslabelvalue">CANVASLABELVALUE</h3>
|
|
472
670
|
<p><strong>Draws the text value of a telemetry item onto the canvas in an optional frame</strong></p>
|
|
473
671
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Font Size</td><td>Font size of the text (Default = 12)</td><td>False</td></tr><tr><td>Color</td><td>Color of the text</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table>
|
|
474
672
|
<p>Example Usage:</p>
|
|
475
|
-
<
|
|
476
|
-
|
|
673
|
+
<pre><code class="language-ruby">CANVAS 200 100
|
|
674
|
+
CANVASLABELVALUE INST HEALTH_STATUS TEMP1 5 34 12 red
|
|
675
|
+
CANVASLABELVALUE INST HEALTH_STATUS TEMP2 5 70 10 blue WITH_UNITS
|
|
676
|
+
END
|
|
677
|
+
</code></pre>
|
|
678
|
+
<h3 id="canvasimage">CANVASIMAGE</h3>
|
|
477
679
|
<p><strong>Displays an image on the canvas</strong></p>
|
|
478
680
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Image filename</td><td>Name of a image file. The file must be in the plugin's targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr></tbody></table>
|
|
479
681
|
<p>Example Usage:</p>
|
|
480
|
-
<
|
|
682
|
+
<pre><code class="language-ruby">CANVAS 250 430
|
|
683
|
+
CANVASIMAGE "satellite.png" 10 10 200 200
|
|
684
|
+
SETTING SCREEN INST HS
|
|
685
|
+
CANVASIMAGE "https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=640&w=426" 0 250 250 150
|
|
686
|
+
END
|
|
687
|
+
</code></pre>
|
|
481
688
|
<p>The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword.</p>
|
|
482
|
-
<h4
|
|
689
|
+
<h4 id="screen-1">SCREEN</h4>
|
|
483
690
|
<p><strong>Open another screen when clicked</strong></p>
|
|
484
691
|
<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>Screen name</td><td>Name of the screen</td><td>True</td></tr></tbody></table>
|
|
485
|
-
<h3
|
|
692
|
+
<h3 id="canvasimagevalue">CANVASIMAGEVALUE</h3>
|
|
486
693
|
<p><strong>Displays an image on the canvas that changes with a telemetry value</strong></p>
|
|
487
694
|
<p>Use various SETTING values to indicate which images should be displayed based on telemetry. For example, SETTING IMAGE CONNECTED "ground_on.png" 400 100. See the DEMO for a complete example.</p>
|
|
488
695
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>True</td></tr><tr><td>Default image filename</td><td>The default image to display. The file must be in the targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Image width</td><td>Width of the image (default is 100%)</td><td>False</td></tr><tr><td>Image height</td><td>Height of the image (default is 100%)</td><td>False</td></tr></tbody></table>
|
|
489
696
|
<p>Example Usage:</p>
|
|
490
|
-
<
|
|
697
|
+
<pre><code class="language-ruby">CANVAS 230 230
|
|
698
|
+
CANVASIMAGEVALUE INST HEALTH_STATUS GROUND1STATUS CONVERTED "ground_error.png" 10 10 180 180
|
|
699
|
+
SETTING IMAGE CONNECTED "ground_on.png" 10 10
|
|
700
|
+
SETTING IMAGE UNAVAILABLE "ground_off.png" 10 10
|
|
701
|
+
SETTING SCREEN INST HS
|
|
702
|
+
END
|
|
703
|
+
</code></pre>
|
|
491
704
|
<p>The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword.</p>
|
|
492
|
-
<h4
|
|
705
|
+
<h4 id="image">IMAGE</h4>
|
|
493
706
|
<p><strong>Map an image to a state or value</strong></p>
|
|
494
707
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value</td><td>True</td></tr><tr><td>Image filename</td><td>Image to display. The file must be in the targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr></tbody></table>
|
|
495
|
-
<h4
|
|
708
|
+
<h4 id="screen-2">SCREEN</h4>
|
|
496
709
|
<p><strong>Open another screen when clicked</strong></p>
|
|
497
710
|
<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>Screen name</td><td>Name of the screen</td><td>True</td></tr></tbody></table>
|
|
498
|
-
<h3
|
|
711
|
+
<h3 id="canvasline">CANVASLINE</h3>
|
|
499
712
|
<p><strong>Draws a line onto the canvas</strong></p>
|
|
500
713
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start X Position</td><td>X position of the start of the line on the canvas</td><td>True</td></tr><tr><td>Start Y Position</td><td>Y position of the start of the line on the canvas</td><td>True</td></tr><tr><td>End X Position</td><td>X position of the end of the line on the canvas</td><td>True</td></tr><tr><td>End Y Position</td><td>Y position of the end of the line on the canvas</td><td>True</td></tr><tr><td>Color</td><td>Color of the line</td><td>False</td></tr><tr><td>Width</td><td>Width of the line in pixels (default = 1)</td><td>False</td></tr></tbody></table>
|
|
501
714
|
<p>Example Usage:</p>
|
|
502
|
-
<
|
|
503
|
-
|
|
715
|
+
<pre><code class="language-ruby">CANVAS 100 50
|
|
716
|
+
CANVASLINE 5 5 95 5
|
|
717
|
+
CANVASLINE 5 5 5 45 green 2
|
|
718
|
+
CANVASLINE 95 5 95 45 blue 3
|
|
719
|
+
END
|
|
720
|
+
</code></pre>
|
|
721
|
+
<h3 id="canvaslinevalue">CANVASLINEVALUE</h3>
|
|
504
722
|
<p><strong>Draws a color changing line onto the canvas</strong></p>
|
|
505
723
|
<p>The line is represented by one of two colors based on the value of the associated telemetry item</p>
|
|
506
724
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Start X Position</td><td>X position of the start of the line on the canvas</td><td>True</td></tr><tr><td>Start Y Position</td><td>Y position of the start of the line on the canvas</td><td>True</td></tr><tr><td>End X Position</td><td>X position of the end of the line on the canvas</td><td>True</td></tr><tr><td>End Y Position</td><td>Y position of the end of the line on the canvas</td><td>True</td></tr><tr><td>Width</td><td>Width of the line in pixels (default = 3)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table>
|
|
507
725
|
<p>Example Usage:</p>
|
|
508
|
-
<
|
|
726
|
+
<pre><code class="language-ruby">CANVAS 120 50
|
|
727
|
+
CANVASLABELVALUE INST HEALTH_STATUS GROUND1STATUS 0 12 12 black
|
|
728
|
+
CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 25 115 25 5 RAW
|
|
729
|
+
SETTING VALUE_EQ 1 GREEN
|
|
730
|
+
SETTING VALUE_EQ 0 RED
|
|
731
|
+
CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 45 115 45
|
|
732
|
+
SETTING VALUE_EQ CONNECTED GREEN
|
|
733
|
+
SETTING VALUE_EQ UNAVAILABLE RED
|
|
734
|
+
END
|
|
735
|
+
</code></pre>
|
|
509
736
|
<p>The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword.</p>
|
|
510
|
-
<h4
|
|
737
|
+
<h4 id="value_eq">VALUE_EQ</h4>
|
|
511
738
|
<p></p><div class="right">(Since 5.5.1)</div><strong>Map a value to a color</strong><p></p>
|
|
512
739
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value</td><td>True</td></tr><tr><td>Color</td><td>Color of the line</td><td>True</td></tr></tbody></table>
|
|
513
|
-
<h3
|
|
740
|
+
<h3 id="canvasdot">CANVASDOT</h3>
|
|
514
741
|
<p><strong>Draws a dot onto the canvas</strong></p>
|
|
515
742
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>X Position</td><td>X position of the dot</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the dot</td><td>True</td></tr><tr><td>Color</td><td>Color of the dot</td><td>True</td></tr><tr><td>Radius</td><td>Radius of the dot in pixels</td><td>True</td></tr></tbody></table>
|
|
516
743
|
<p>Example Usage:</p>
|
|
517
|
-
<
|
|
518
|
-
|
|
744
|
+
<pre><code class="language-ruby">CANVAS 50 50
|
|
745
|
+
CANVASDOT 10 15 BLUE 5
|
|
746
|
+
END
|
|
747
|
+
</code></pre>
|
|
748
|
+
<h2 id="example-file">Example File</h2>
|
|
519
749
|
<p>Example File: TARGET/myscreen.txt</p>
|
|
520
|
-
<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)">SCREEN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">AUTO</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">AUTO</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">VERTICAL</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)">TITLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"<%= target_name %> Commanding Examples"</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)">LABELVALUE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECTS</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)">LABELVALUE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_TYPE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DURATION</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VERTICALBOX</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Send Collect Command:"</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)">HORIZONTAL</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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Type: "</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NAMED_WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_TYPE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMBOBOX</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 constant" style="color:rgb(130, 170, 255)">SPECIAL</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HORIZONTAL</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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">" Duration: "</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)">NAMED_WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DURATION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEXTFIELD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"10.0"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">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)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Start Collect'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"api.cmd('INST COLLECT with TYPE '+screen.getNamedWidget('COLLECT_TYPE').text()+', DURATION '+screen.getNamedWidget('DURATION').text())"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BACKCOLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">185</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</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)">VERTICALBOX</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Parameter-less Commands:"</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)">NAMED_WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GROUP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RADIOGROUP</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Select 'Clear' initially, 0-based index</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)">RADIOBUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Abort'</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)">RADIOBUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Clear'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NAMED_WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CHECK</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CHECKBUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Ignore Hazardous Checks'</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># No option is by default UNCHECKED</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)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Send'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"screen.getNamedWidget('GROUP').selected() === 0 ? api.cmd('INST ABORT') : (screen.getNamedWidget('CHECK').checked() ? api.cmd_no_hazardous_check('INST CLEAR') : api.cmd('INST CLEAR'))"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BACKCOLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">185</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></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-screens.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/table"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Tables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/ssl-tls"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">SSL-TLS</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="#definitions" class="table-of-contents__link toc-highlight">Definitions</a></li><li><a href="#telemetry-screen-definition-files" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets" class="table-of-contents__link toc-highlight">New Widgets</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li><li><a href="#end" class="table-of-contents__link toc-highlight">END</a></li><li><a href="#stale_time" class="table-of-contents__link toc-highlight">STALE_TIME</a></li><li><a href="#global_setting" class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a></li><li><a href="#global_subsetting" class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a></li><li><a href="#setting" class="table-of-contents__link toc-highlight">SETTING</a><ul><li><a href="#width" class="table-of-contents__link toc-highlight">WIDTH</a></li><li><a href="#height" class="table-of-contents__link toc-highlight">HEIGHT</a></li><li><a href="#margin" class="table-of-contents__link toc-highlight">MARGIN</a></li><li><a href="#padding" class="table-of-contents__link toc-highlight">PADDING</a></li><li><a href="#backcolor" class="table-of-contents__link toc-highlight">BACKCOLOR</a></li><li><a href="#textcolor" class="table-of-contents__link toc-highlight">TEXTCOLOR</a></li><li><a href="#bordercolor" class="table-of-contents__link toc-highlight">BORDERCOLOR</a></li><li><a href="#raw" class="table-of-contents__link toc-highlight">RAW</a></li></ul></li><li><a href="#subsetting" class="table-of-contents__link toc-highlight">SUBSETTING</a></li><li><a href="#named_widget" class="table-of-contents__link toc-highlight">NAMED_WIDGET</a></li><li><a href="#layout-widgets" class="table-of-contents__link toc-highlight">Layout Widgets</a><ul><li><a href="#vertical" class="table-of-contents__link toc-highlight">VERTICAL</a></li><li><a href="#verticalbox" class="table-of-contents__link toc-highlight">VERTICALBOX</a></li><li><a href="#horizontal" class="table-of-contents__link toc-highlight">HORIZONTAL</a></li><li><a href="#horizontalbox" class="table-of-contents__link toc-highlight">HORIZONTALBOX</a></li><li><a href="#matrixbycolumns" class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a></li><li><a href="#scrollwindow" class="table-of-contents__link toc-highlight">SCROLLWINDOW</a></li><li><a href="#tabbook" class="table-of-contents__link toc-highlight">TABBOOK</a></li><li><a href="#tabitem" class="table-of-contents__link toc-highlight">TABITEM</a></li><li><a href="#iframe" class="table-of-contents__link toc-highlight">IFRAME</a></li></ul></li><li><a href="#decoration-widgets" class="table-of-contents__link toc-highlight">Decoration Widgets</a><ul><li><a href="#label" class="table-of-contents__link toc-highlight">LABEL</a></li><li><a href="#horizontalline" class="table-of-contents__link toc-highlight">HORIZONTALLINE</a></li><li><a href="#sectionheader" class="table-of-contents__link toc-highlight">SECTIONHEADER</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">TITLE</a></li><li><a href="#spacer" class="table-of-contents__link toc-highlight">SPACER</a></li></ul></li><li><a href="#telemetry-widgets" class="table-of-contents__link toc-highlight">Telemetry Widgets</a><ul><li><a href="#array" class="table-of-contents__link toc-highlight">ARRAY</a></li><li><a href="#block" class="table-of-contents__link toc-highlight">BLOCK</a></li><li><a href="#formatvalue" class="table-of-contents__link toc-highlight">FORMATVALUE</a></li><li><a href="#labelled" class="table-of-contents__link toc-highlight">LABELLED</a><ul><li><a href="#led_color" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#labelprogressbar" class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a></li><li><a href="#labelvalue" class="table-of-contents__link toc-highlight">LABELVALUE</a></li><li><a href="#labelvaluedesc" class="table-of-contents__link toc-highlight">LABELVALUEDESC</a></li><li><a href="#labelvaluelimitsbar" class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a></li><li><a href="#labelvaluelimitscolumn" class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a></li><li><a href="#labelvaluerangebar" class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a></li><li><a href="#led" class="table-of-contents__link toc-highlight">LED</a><ul><li><a href="#led_color-1" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#limitsbar" class="table-of-contents__link toc-highlight">LIMITSBAR</a></li><li><a href="#limitscolumn" class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a></li><li><a href="#limitscolor" class="table-of-contents__link toc-highlight">LIMITSCOLOR</a></li><li><a href="#valuelimitsbar" class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a></li><li><a href="#valuelimitscolumn" class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a></li><li><a href="#valuerangebar" class="table-of-contents__link toc-highlight">VALUERANGEBAR</a></li><li><a href="#linegraph" class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#sparkline" class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href="#item-1" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-1" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-1" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-1" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-1" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-1" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-1" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#labelsparkline" class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href="#item-2" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-2" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-2" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-2" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-2" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-2" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-2" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#imageviewer" class="table-of-contents__link toc-highlight">IMAGEVIEWER</a></li><li><a href="#progressbar" class="table-of-contents__link toc-highlight">PROGRESSBAR</a></li><li><a href="#rangebar" class="table-of-contents__link toc-highlight">RANGEBAR</a></li><li><a href="#textbox" class="table-of-contents__link toc-highlight">TEXTBOX</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">VALUE</a></li></ul></li><li><a href="#interactive-widgets" class="table-of-contents__link toc-highlight">Interactive Widgets</a><ul><li><a href="#button" class="table-of-contents__link toc-highlight">BUTTON</a></li></ul></li><li><a href="#button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens" class="table-of-contents__link toc-highlight">Button code can get rather complex so remember to use string concatenation
|
|
750
|
+
<pre><code class="language-ruby">SCREEN AUTO AUTO 0.5
|
|
751
|
+
VERTICAL
|
|
752
|
+
TITLE "<%= target_name %> Commanding Examples"
|
|
753
|
+
LABELVALUE INST HEALTH_STATUS COLLECTS
|
|
754
|
+
LABELVALUE INST HEALTH_STATUS COLLECT_TYPE
|
|
755
|
+
LABELVALUE INST HEALTH_STATUS DURATION
|
|
756
|
+
VERTICALBOX "Send Collect Command:"
|
|
757
|
+
HORIZONTAL
|
|
758
|
+
LABEL "Type: "
|
|
759
|
+
NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL
|
|
760
|
+
END
|
|
761
|
+
HORIZONTAL
|
|
762
|
+
LABEL " Duration: "
|
|
763
|
+
NAMED_WIDGET DURATION TEXTFIELD 12 "10.0"
|
|
764
|
+
END
|
|
765
|
+
BUTTON 'Start Collect' "api.cmd('INST COLLECT with TYPE '+screen.getNamedWidget('COLLECT_TYPE').text()+', DURATION '+screen.getNamedWidget('DURATION').text())"
|
|
766
|
+
END
|
|
767
|
+
SETTING BACKCOLOR 163 185 163
|
|
768
|
+
VERTICALBOX "Parameter-less Commands:"
|
|
769
|
+
NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index
|
|
770
|
+
RADIOBUTTON 'Abort'
|
|
771
|
+
RADIOBUTTON 'Clear'
|
|
772
|
+
END
|
|
773
|
+
NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks' # No option is by default UNCHECKED
|
|
774
|
+
BUTTON 'Send' "screen.getNamedWidget('GROUP').selected() === 0 ? api.cmd('INST ABORT') : (screen.getNamedWidget('CHECK').checked() ? api.cmd_no_hazardous_check('INST CLEAR') : api.cmd('INST CLEAR'))"
|
|
775
|
+
END
|
|
776
|
+
SETTING BACKCOLOR 163 185 163
|
|
777
|
+
END
|
|
778
|
+
</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-screens.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/table"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Tables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/ssl-tls"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">SSL-TLS</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="#definitions" class="table-of-contents__link toc-highlight">Definitions</a></li><li><a href="#telemetry-screen-definition-files" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets" class="table-of-contents__link toc-highlight">New Widgets</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li><li><a href="#end" class="table-of-contents__link toc-highlight">END</a></li><li><a href="#stale_time" class="table-of-contents__link toc-highlight">STALE_TIME</a></li><li><a href="#global_setting" class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a></li><li><a href="#global_subsetting" class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a></li><li><a href="#setting" class="table-of-contents__link toc-highlight">SETTING</a><ul><li><a href="#width" class="table-of-contents__link toc-highlight">WIDTH</a></li><li><a href="#height" class="table-of-contents__link toc-highlight">HEIGHT</a></li><li><a href="#margin" class="table-of-contents__link toc-highlight">MARGIN</a></li><li><a href="#padding" class="table-of-contents__link toc-highlight">PADDING</a></li><li><a href="#backcolor" class="table-of-contents__link toc-highlight">BACKCOLOR</a></li><li><a href="#textcolor" class="table-of-contents__link toc-highlight">TEXTCOLOR</a></li><li><a href="#bordercolor" class="table-of-contents__link toc-highlight">BORDERCOLOR</a></li><li><a href="#raw" class="table-of-contents__link toc-highlight">RAW</a></li></ul></li><li><a href="#subsetting" class="table-of-contents__link toc-highlight">SUBSETTING</a></li><li><a href="#named_widget" class="table-of-contents__link toc-highlight">NAMED_WIDGET</a></li><li><a href="#layout-widgets" class="table-of-contents__link toc-highlight">Layout Widgets</a><ul><li><a href="#vertical" class="table-of-contents__link toc-highlight">VERTICAL</a></li><li><a href="#verticalbox" class="table-of-contents__link toc-highlight">VERTICALBOX</a></li><li><a href="#horizontal" class="table-of-contents__link toc-highlight">HORIZONTAL</a></li><li><a href="#horizontalbox" class="table-of-contents__link toc-highlight">HORIZONTALBOX</a></li><li><a href="#matrixbycolumns" class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a></li><li><a href="#scrollwindow" class="table-of-contents__link toc-highlight">SCROLLWINDOW</a></li><li><a href="#tabbook" class="table-of-contents__link toc-highlight">TABBOOK</a></li><li><a href="#tabitem" class="table-of-contents__link toc-highlight">TABITEM</a></li><li><a href="#iframe" class="table-of-contents__link toc-highlight">IFRAME</a></li></ul></li><li><a href="#decoration-widgets" class="table-of-contents__link toc-highlight">Decoration Widgets</a><ul><li><a href="#label" class="table-of-contents__link toc-highlight">LABEL</a></li><li><a href="#horizontalline" class="table-of-contents__link toc-highlight">HORIZONTALLINE</a></li><li><a href="#sectionheader" class="table-of-contents__link toc-highlight">SECTIONHEADER</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">TITLE</a></li><li><a href="#spacer" class="table-of-contents__link toc-highlight">SPACER</a></li></ul></li><li><a href="#telemetry-widgets" class="table-of-contents__link toc-highlight">Telemetry Widgets</a><ul><li><a href="#array" class="table-of-contents__link toc-highlight">ARRAY</a></li><li><a href="#block" class="table-of-contents__link toc-highlight">BLOCK</a></li><li><a href="#formatvalue" class="table-of-contents__link toc-highlight">FORMATVALUE</a></li><li><a href="#labelled" class="table-of-contents__link toc-highlight">LABELLED</a><ul><li><a href="#led_color" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#labelprogressbar" class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a></li><li><a href="#labelvalue" class="table-of-contents__link toc-highlight">LABELVALUE</a></li><li><a href="#labelvaluedesc" class="table-of-contents__link toc-highlight">LABELVALUEDESC</a></li><li><a href="#labelvaluelimitsbar" class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a></li><li><a href="#labelvaluelimitscolumn" class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a></li><li><a href="#labelvaluerangebar" class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a></li><li><a href="#led" class="table-of-contents__link toc-highlight">LED</a><ul><li><a href="#led_color-1" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#limitsbar" class="table-of-contents__link toc-highlight">LIMITSBAR</a></li><li><a href="#limitscolumn" class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a></li><li><a href="#limitscolor" class="table-of-contents__link toc-highlight">LIMITSCOLOR</a></li><li><a href="#valuelimitsbar" class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a></li><li><a href="#valuelimitscolumn" class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a></li><li><a href="#valuerangebar" class="table-of-contents__link toc-highlight">VALUERANGEBAR</a></li><li><a href="#linegraph" class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#sparkline" class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href="#item-1" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-1" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-1" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-1" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-1" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-1" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-1" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#labelsparkline" class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href="#item-2" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-2" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-2" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-2" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-2" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-2" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-2" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#imageviewer" class="table-of-contents__link toc-highlight">IMAGEVIEWER</a></li><li><a href="#progressbar" class="table-of-contents__link toc-highlight">PROGRESSBAR</a></li><li><a href="#rangebar" class="table-of-contents__link toc-highlight">RANGEBAR</a></li><li><a href="#textbox" class="table-of-contents__link toc-highlight">TEXTBOX</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">VALUE</a></li></ul></li><li><a href="#interactive-widgets" class="table-of-contents__link toc-highlight">Interactive Widgets</a><ul><li><a href="#button" class="table-of-contents__link toc-highlight">BUTTON</a></li></ul></li><li><a href="#button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens" class="table-of-contents__link toc-highlight">Button code can get rather complex so remember to use string concatenation
|
|
521
779
|
to make things more readable. If you use <code>+</code> newlines are inserted automatically
|
|
522
780
|
during string concatenation. If you use `---
|
|
523
781
|
sidebar_position: 9
|