openc3-cosmos-tool-docs 6.4.1 → 6.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +4 -1
- data/tools/staticdocs/assets/css/styles.1a361da6.css +1 -0
- data/tools/staticdocs/assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png +0 -0
- data/tools/staticdocs/assets/images/docker-security-bb6d4bdd60a5cd7df87a572159c6369b67bee5735be5a501b25786cabdcd4228.png +0 -0
- data/tools/staticdocs/assets/images/tlm-processing-ce5d4cc16e4a19d9c4f799cc8af975e93eb1c54ba0d43acbc31cc048667b223d.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5dd06a57.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.ed3ac5fa.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ef66a55c.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.43788fd9.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.7aacaf90.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.7aa50138.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.ff33b528.js +1 -0
- data/tools/staticdocs/assets/js/13196248.14de6ce1.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.2dafa283.js +1 -0
- data/tools/staticdocs/assets/js/1602.502ef9b1.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.d99a363c.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.d91543a5.js +1 -0
- data/tools/staticdocs/assets/js/2124.545702e0.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.5eb8d876.js +1 -0
- data/tools/staticdocs/assets/js/2368.fd1bb46a.js +4 -0
- data/tools/staticdocs/assets/js/26b8abb2.021651f5.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.1eee5bcb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.7f30b517.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.4f30c5da.js +1 -0
- data/tools/staticdocs/assets/js/3687.8bc61ef3.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.dfbe9bb7.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.42b05c12.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e55efd5d.js +1 -0
- data/tools/staticdocs/assets/js/42170351.2de491d4.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.f7c95691.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.2da36c11.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.7cc2c5cc.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.29533a03.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.62d9a8b8.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.40e0caf8.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.64ea5a52.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.2d29f3fb.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.ec0009ac.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.1c205c60.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.32ded6d5.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.b2a62736.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.e0eb7741.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7719.0d312792.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.a0dfbdf7.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.32ca371f.js +1 -0
- data/tools/staticdocs/assets/js/{89e76475.e1b0dbdb.js → 89e76475.20b3a636.js} +1 -1
- data/tools/staticdocs/assets/js/8f7843ee.6d7c9cd4.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.75b12400.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.0eee94ba.js +1 -0
- data/tools/staticdocs/assets/js/97535711.630cee4d.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.73b5cd90.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.6b6404ff.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.715fc441.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.76d13f14.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.3b3e7379.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.da1da6f1.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.bc122746.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.4e8142cb.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.4a10f506.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.08749f15.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.776bc00f.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.ce400445.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.a201a4a7.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.77326c08.js +1 -0
- data/tools/staticdocs/assets/js/{c2598f55.812cdcd1.js → c2598f55.85419dc8.js} +1 -1
- data/tools/staticdocs/assets/js/cb8c3f08.73cefada.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.dc2adfcc.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.57f5e162.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.73bb876f.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.e348c06d.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.885590b1.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1143a9d4.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.0ffb9759.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.fe602968.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.a115a366.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.1aefa4e7.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.9c957b0c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.ddc630ca.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.f9c2d1fc.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.a4d98d69.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.656b4fa3.js +1 -0
- data/tools/staticdocs/assets/js/main.ba1fa268.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.ca894d1e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +21 -18
- data/tools/staticdocs/docs/configuration/command.html +35 -35
- data/tools/staticdocs/docs/configuration/conversions.html +156 -0
- data/tools/staticdocs/docs/configuration/format.html +18 -15
- data/tools/staticdocs/docs/configuration/interfaces.html +34 -31
- data/tools/staticdocs/docs/configuration/plugins.html +39 -36
- data/tools/staticdocs/docs/configuration/protocols.html +28 -25
- data/tools/staticdocs/docs/configuration/ssl-tls.html +10 -6
- data/tools/staticdocs/docs/configuration/table.html +19 -22
- data/tools/staticdocs/docs/configuration/target.html +11 -8
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +72 -69
- data/tools/staticdocs/docs/configuration/telemetry.html +40 -40
- data/tools/staticdocs/docs/configuration.html +4 -1
- data/tools/staticdocs/docs/development/curl.html +12 -9
- data/tools/staticdocs/docs/development/developing.html +15 -12
- data/tools/staticdocs/docs/development/json-api.html +8 -5
- data/tools/staticdocs/docs/development/log-structure.html +5 -2
- data/tools/staticdocs/docs/development/roadmap.html +5 -2
- data/tools/staticdocs/docs/development/streaming-api.html +13 -10
- data/tools/staticdocs/docs/development/testing.html +15 -12
- data/tools/staticdocs/docs/development.html +4 -1
- data/tools/staticdocs/docs/getting-started/cli.html +16 -13
- data/tools/staticdocs/docs/getting-started/generators.html +19 -16
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +15 -12
- data/tools/staticdocs/docs/getting-started/installation.html +7 -4
- data/tools/staticdocs/docs/getting-started/key-concepts.html +6 -3
- data/tools/staticdocs/docs/getting-started/podman.html +19 -16
- data/tools/staticdocs/docs/getting-started/requirements.html +7 -4
- data/tools/staticdocs/docs/getting-started/upgrading.html +23 -15
- data/tools/staticdocs/docs/getting-started.html +4 -1
- data/tools/staticdocs/docs/guides/bridges.html +7 -4
- data/tools/staticdocs/docs/guides/cfs.html +19 -16
- data/tools/staticdocs/docs/guides/custom-widgets.html +54 -16
- data/tools/staticdocs/docs/guides/dynamic-packets.html +9 -6
- data/tools/staticdocs/docs/guides/exposing-microservices.html +9 -6
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +6 -3
- data/tools/staticdocs/docs/guides/local-mode.html +6 -3
- data/tools/staticdocs/docs/guides/logging.html +5 -2
- data/tools/staticdocs/docs/guides/monitoring.html +11 -8
- data/tools/staticdocs/docs/guides/performance.html +6 -3
- data/tools/staticdocs/docs/guides/raspberrypi.html +6 -3
- data/tools/staticdocs/docs/guides/reference-architectures.html +35 -0
- data/tools/staticdocs/docs/guides/script-writing.html +46 -43
- data/tools/staticdocs/docs/guides/scripting-api.html +627 -433
- data/tools/staticdocs/docs/guides.html +4 -1
- data/tools/staticdocs/docs/meta/contributing.html +10 -7
- data/tools/staticdocs/docs/meta/licenses.html +6 -3
- data/tools/staticdocs/docs/meta/philosophy.html +5 -2
- data/tools/staticdocs/docs/meta/xtce.html +7 -4
- data/tools/staticdocs/docs/meta.html +4 -1
- data/tools/staticdocs/docs/privacy.html +5 -2
- data/tools/staticdocs/docs/tools/admin.html +5 -2
- data/tools/staticdocs/docs/tools/autonomic.html +5 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +5 -2
- data/tools/staticdocs/docs/tools/calendar.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +5 -2
- data/tools/staticdocs/docs/tools/command_history.html +5 -2
- data/tools/staticdocs/docs/tools/data-extractor.html +5 -2
- data/tools/staticdocs/docs/tools/data-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/handbooks.html +5 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +5 -2
- data/tools/staticdocs/docs/tools/packet-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/script-runner.html +9 -6
- data/tools/staticdocs/docs/tools/table-manager.html +6 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +5 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +5 -2
- data/tools/staticdocs/docs/tools.html +4 -1
- data/tools/staticdocs/docs.html +6 -8
- data/tools/staticdocs/img/cmd-processing.png +0 -0
- data/tools/staticdocs/img/docker-local-security.png +0 -0
- data/tools/staticdocs/img/docker-security.png +0 -0
- data/tools/staticdocs/img/tlm-processing.png +0 -0
- data/tools/staticdocs/index.html +4 -1
- data/tools/staticdocs/lunr-index-1748640055686.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +5 -2
- data/tools/staticdocs/search-doc-1748640055686.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +94 -83
- data/tools/staticdocs/assets/css/styles.1de6b959.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.43fd7635.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.5cfabd67.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.0e2ea47d.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.5515d5e3.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.7697df48.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.f81b787b.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.e7943c80.js +0 -1
- data/tools/staticdocs/assets/js/13196248.ea83002e.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.eb5250f4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.d91f6c3e.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.0df9587b.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.7f8d4cb0.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.1772f030.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.fcf47881.js +0 -1
- data/tools/staticdocs/assets/js/3969.afdd070b.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.c3455b97.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.5ed2e9b5.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.f7b3ff17.js +0 -1
- data/tools/staticdocs/assets/js/42170351.fbc05869.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.60fa883f.js +0 -1
- data/tools/staticdocs/assets/js/5205.c6f31e57.js +0 -1
- data/tools/staticdocs/assets/js/5328.3e2a53eb.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.fe331a71.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.ef91ba12.js +0 -1
- data/tools/staticdocs/assets/js/5761.e7fabbc9.js +0 -4
- data/tools/staticdocs/assets/js/5b233ba7.9d6ba314.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.8b51f7c0.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.63b46202.js +0 -1
- data/tools/staticdocs/assets/js/651.a043d7b1.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.1318b398.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.1e950fcb.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.6a77064a.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.0376a397.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.6439052e.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.b6fcfc30.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.324643a8.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.607160d3.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.27d9d599.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.abe30983.js +0 -1
- data/tools/staticdocs/assets/js/9357.9a7e89b5.js +0 -101
- data/tools/staticdocs/assets/js/9424f0b3.3683501c.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.0e04c58d.js +0 -1
- data/tools/staticdocs/assets/js/97535711.e595488c.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.841b4a2e.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.36405219.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.821f7504.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.cfa50691.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.b418f772.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.805dc1ba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.ef9b0f38.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.57d6e194.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.c648533a.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.a9228642.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.4c0bb1dd.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.8ad39448.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.0575c394.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.07d1c9e9.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.59af1749.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.da892cde.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.a58b9bbd.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.9fef8263.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.c74b62b1.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.e812e6e7.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.80a50660.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.8df86c99.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.5db8667e.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.f1eed806.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.75e9fc53.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.9e4e6681.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.d3a1e4bc.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.49804e96.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.124ffe26.js +0 -1
- data/tools/staticdocs/assets/js/main.b1edeb65.js +0 -36
- data/tools/staticdocs/assets/js/runtime~main.3629ffb4.js +0 -1
- data/tools/staticdocs/lunr-index-1747245438937.json +0 -1
- data/tools/staticdocs/search-doc-1747245438937.json +0 -1
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/telemetry-screens" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Screens | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/configuration/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="Telemetry Viewer screen definition and widget documentation"><meta data-rh=true property=og:description content="Telemetry Viewer screen definition and widget documentation"><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.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.3629ffb4.js defer></script><script src=/tools/staticdocs/assets/js/main.b1edeb65.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Screens</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>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>
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/telemetry-screens" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.0"><title data-rh=true>Screens | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/configuration/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="Telemetry Viewer screen definition and widget documentation"><meta data-rh=true property=og:description content="Telemetry Viewer screen definition and widget documentation"><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><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens","name":"Screens","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.ca894d1e.js defer></script><script src=/tools/staticdocs/assets/js/main.ba1fa268.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
|
2
|
+
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
|
+
</defs></svg>
|
|
4
|
+
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions>Conversions</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Screens</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>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>
|
|
2
5
|
<div style=clear:both></div>
|
|
3
6
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=definitions>Definitions<a href=#definitions class=hash-link aria-label="Direct link to Definitions" title="Direct link to Definitions"></a></h2>
|
|
4
7
|
<table><thead><tr><th>Name<th>Definition<tbody><tr><td>Widget<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.<tr><td>Screen<td>A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion.<tr><td>Screen Definition File<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.</table>
|
|
@@ -12,7 +15,7 @@
|
|
|
12
15
|
<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>
|
|
13
16
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Width<td>Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen<td>True<tr><td>Height<td>Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen<td>True<tr><td>Polling Period<td>Number of seconds between screen updates<td>True</table>
|
|
14
17
|
<p>Example Usage:</p>
|
|
15
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
18
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">1.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><br></span></code></pre></div></div>
|
|
16
19
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=end>END<a href=#end class=hash-link aria-label="Direct link to END" title="Direct link to END"></a></h2>
|
|
17
20
|
<p><strong>Indicates the close of a layout widget</strong></p>
|
|
18
21
|
<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>
|
|
@@ -20,18 +23,18 @@
|
|
|
20
23
|
<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>
|
|
21
24
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>value<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>True</table>
|
|
22
25
|
<p>Example Usage:</p>
|
|
23
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
26
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">STALE_TIME</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Number of seconds to wait before marking data stale</span><br></span></code></pre></div></div>
|
|
24
27
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=global_setting>GLOBAL_SETTING<a href=#global_setting class=hash-link aria-label="Direct link to GLOBAL_SETTING" title="Direct link to GLOBAL_SETTING"></a></h2>
|
|
25
28
|
<p><strong>Applies a widget setting to all widgets of a certain type</strong></p>
|
|
26
29
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Widget Class Name<td>The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON.<td>True<tr><td>Setting Name<td>See SETTING for details.<td>True<tr><td>Setting Value(s)<td>See SETTING for details.<td>False</table>
|
|
27
30
|
<p>Example Usage:</p>
|
|
28
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
31
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">GLOBAL_SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUELIMITSBAR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEXTCOLOR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BLACK</span><br></span></code></pre></div></div>
|
|
29
32
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=global_subsetting>GLOBAL_SUBSETTING<a href=#global_subsetting class=hash-link aria-label="Direct link to GLOBAL_SUBSETTING" title="Direct link to GLOBAL_SUBSETTING"></a></h2>
|
|
30
33
|
<p><strong>Applies a widget subsetting to all widgets of a certain type</strong></p>
|
|
31
34
|
<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 widget, pass 0 as the Subwidget Index, pass 1 for the Value widget, and 2 for the LimitsBar widget.</p>
|
|
32
35
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Widget Class Name<td>The name of the class of widgets that this setting will be applied to. For example, LABELVALUE.<td>True<tr><td>Subwidget Index<td>Index to the desired subwidget<td>True<tr><td>Setting Name<td>See SETTING for details.<td>True<tr><td>Setting Value(s)<td>See SETTING for details.<td>False</table>
|
|
33
36
|
<p>Example Usage:</p>
|
|
34
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
37
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Set all text color to white for labelvaluelimitsbars</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)">GLOBAL_SUBSETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUELIMITSBAR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEXTCOLOR</span><span class="token plain"> white</span><br></span></code></pre></div></div>
|
|
35
38
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=setting>SETTING<a href=#setting class=hash-link aria-label="Direct link to SETTING" title="Direct link to SETTING"></a></h2>
|
|
36
39
|
<p><strong>Applies a widget setting to the previously defined widget</strong></p>
|
|
37
40
|
<p>Settings allow for additional tweaks and options to be applied to widgets
|
|
@@ -46,59 +49,59 @@ unique settings which are documented under that specific widget.</p>
|
|
|
46
49
|
<p>WIDTH supports <a href=https://www.w3schools.com/cssref/css_units.php target=_blank rel="noopener noreferrer">css units</a> with the default (no units) of px (pixels)</p>
|
|
47
50
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Width<td>Width in pixels or explicitly declared with units<td>True</table>
|
|
48
51
|
<p>Example Usage:</p>
|
|
49
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
52
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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)">WIDTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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)">WIDTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</span><span class="token plain">em</span><br></span></code></pre></div></div>
|
|
50
53
|
<p><img decoding=async loading=lazy alt=WIDTH src=/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png width=678 height=326 class=img__Ss2></p>
|
|
51
54
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=height>HEIGHT<a href=#height class=hash-link aria-label="Direct link to HEIGHT" title="Direct link to HEIGHT"></a></h3>
|
|
52
55
|
<p><strong>Sets the widget height</strong></p>
|
|
53
56
|
<p>HEIGHT supports <a href=https://www.w3schools.com/cssref/css_units.php target=_blank rel="noopener noreferrer">css units</a> with the default (no units) of px (pixels)</p>
|
|
54
57
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Height<td>Height in pixels or explicitly declared with units<td>True</table>
|
|
55
58
|
<p>Example Usage:</p>
|
|
56
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
59
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">BLUE</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)">HEIGHT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">GREY</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)">HEIGHT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain">em</span><br></span></code></pre></div></div>
|
|
57
60
|
<p><img decoding=async loading=lazy alt=HEIGHT src=/tools/staticdocs/assets/images/height-67268e562da2f9b2d0b9adc38d8fb2ba629504b09d798d8c26be9cfbfdad672a.png width=374 height=224 class=img__Ss2></p>
|
|
58
61
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=margin>MARGIN<a href=#margin class=hash-link aria-label="Direct link to MARGIN" title="Direct link to MARGIN"></a></h3>
|
|
59
62
|
<p><strong>Sets the widget margin</strong></p>
|
|
60
63
|
<p>MARGIN supports <a href=https://www.w3schools.com/cssref/css_units.php target=_blank rel="noopener noreferrer">css units</a> with the default (no units) of px (pixels)</p>
|
|
61
64
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Size in pixels or explicitly declared with units<td>True</table>
|
|
62
65
|
<p>Example Usage:</p>
|
|
63
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
66
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">BLUE</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)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">GREY</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)">MARGIN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">GREEN</span><br></span></code></pre></div></div>
|
|
64
67
|
<p><img decoding=async loading=lazy alt=MARGIN src=/tools/staticdocs/assets/images/margin-4247b51c2c305cb961d08a807f30883b7fc6d9e3316c18174b86afe2356106dd.png width=372 height=336 class=img__Ss2></p>
|
|
65
68
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=padding>PADDING<a href=#padding class=hash-link aria-label="Direct link to PADDING" title="Direct link to PADDING"></a></h3>
|
|
66
69
|
<p><strong>Sets the widget padding</strong></p>
|
|
67
70
|
<p>PADDING supports <a href=https://www.w3schools.com/cssref/css_units.php target=_blank rel="noopener noreferrer">css units</a> with the default (no units) of px (pixels)</p>
|
|
68
71
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Size in pixels or explicitly declared with units<td>True</table>
|
|
69
72
|
<p>Example Usage:</p>
|
|
70
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
73
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">BLUE</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)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">GREY</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)">PADDING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">"THIS IS A TEST"</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 constant" style="color:rgb(130, 170, 255)">GREEN</span><br></span></code></pre></div></div>
|
|
71
74
|
<p><img decoding=async loading=lazy alt=PADDING src=/tools/staticdocs/assets/images/padding-e8ceea8ec79def3b14d186971854c44883675d974409366b77c586eedd85025c.png width=376 height=332 class=img__Ss2></p>
|
|
72
75
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=backcolor>BACKCOLOR<a href=#backcolor class=hash-link aria-label="Direct link to BACKCOLOR" title="Direct link to BACKCOLOR"></a></h3>
|
|
73
76
|
<p><strong>The BACKCOLOR setting sets the background color for a widget</strong></p>
|
|
74
77
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Color name or Red value<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>True<tr><td>Green value<td>Green value of the RGB value<td>False<tr><td>Blue value<td>Blue value of the RGB value<td>False</table>
|
|
75
78
|
<p>Example Usage:</p>
|
|
76
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
79
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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"> red</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)">"THIS IS A TEST"</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)">155</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">155</span><br></span></code></pre></div></div>
|
|
77
80
|
<p><img decoding=async loading=lazy alt=BACKCOLOR src=/tools/staticdocs/assets/images/backcolor-39ca0e2a25bd98fe1c9e067f026f3a719a760d3f14ccb404e2da3a0af4235760.png width=366 height=232 class=img__Ss2></p>
|
|
78
81
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=textcolor>TEXTCOLOR<a href=#textcolor class=hash-link aria-label="Direct link to TEXTCOLOR" title="Direct link to TEXTCOLOR"></a></h3>
|
|
79
82
|
<p><strong>The TEXTCOLOR setting sets the text color for a widget</strong></p>
|
|
80
83
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Color name or Red value<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>True<tr><td>Green value<td>Green value of the RGB value<td>False<tr><td>Blue value<td>Blue value of the RGB value<td>False</table>
|
|
81
84
|
<p>Example Usage:</p>
|
|
82
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
85
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"THIS IS A TEST"</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)">TEXTCOLOR</span><span class="token plain"> red</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)">"THIS IS A TEST"</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)">TEXTCOLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">155</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">155</span><br></span></code></pre></div></div>
|
|
83
86
|
<p><img decoding=async loading=lazy alt=TEXTCOLOR src=/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png width=364 height=220 class=img__Ss2></p>
|
|
84
87
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=bordercolor>BORDERCOLOR<a href=#bordercolor class=hash-link aria-label="Direct link to BORDERCOLOR" title="Direct link to BORDERCOLOR"></a></h3>
|
|
85
88
|
<p><strong>The BORDERCOLOR setting sets the border color for a layout widget</strong></p>
|
|
86
89
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Color name or Red value<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>True<tr><td>Green value<td>Green value of the RGB value<td>False<tr><td>Blue value<td>Blue value of the RGB value<td>False</table>
|
|
87
90
|
<p>Example Usage:</p>
|
|
88
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
91
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">"Label 1"</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)">BORDERCOLOR</span><span class="token plain"> red</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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Label 2"</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)">BORDERCOLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">155</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">155</span><br></span></code></pre></div></div>
|
|
89
92
|
<p><img decoding=async loading=lazy alt=BORDERCOLOR src=/tools/staticdocs/assets/images/bordercolor-a3ac15f24f91c910fcc9c8bd195232205ec44da0b428b11b71108687ce6316d3.png width=362 height=232 class=img__Ss2></p>
|
|
90
93
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=raw>RAW<a href=#raw class=hash-link aria-label="Direct link to RAW" title="Direct link to RAW"></a></h3>
|
|
91
94
|
<p><strong>Apply a raw CSS stylesheet key and value</strong></p>
|
|
92
95
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>CSS key like font-size, max-width, etc<td>True<tr><td>Value<td>CSS Value<td>True</table>
|
|
93
96
|
<p>Example Usage:</p>
|
|
94
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
97
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Label 1"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> font</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">size </span><span class="token number" style="color:rgb(247, 140, 108)">30</span><span class="token plain">px</span><br></span></code></pre></div></div>
|
|
95
98
|
<p><img decoding=async loading=lazy alt=RAW src=/tools/staticdocs/assets/images/raw-63c1dd793f4a734e7d512bf4c0c3722831c38d5392a1a1b0cb77bbef4d16b96b.png width=364 height=194 class=img__Ss2></p>
|
|
96
99
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=subsetting>SUBSETTING<a href=#subsetting class=hash-link aria-label="Direct link to SUBSETTING" title="Direct link to SUBSETTING"></a></h2>
|
|
97
100
|
<p><strong>Applies a widget subsetting to the previously defined widget</strong></p>
|
|
98
101
|
<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 widget, pass 0 as the Subwidget Index, pass 1 for the Value widget, and 2 for the LimitsBar widget.</p>
|
|
99
102
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Subwidget Index<td>Index to the desired subwidget or 'ALL' to apply the setting to all the subwidgets of this composite widget.<td>True<tr><td>Setting Name<td>See SETTING for details.<td>True<tr><td>Setting Value(s)<td>See SETTING for details.<td>False</table>
|
|
100
103
|
<p>Example Usage:</p>
|
|
101
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
104
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VERTICALBOX</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)">TEMP1</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)">SUBSETTING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEXTCOLOR</span><span class="token plain"> blue </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Change the label's text to blue</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)">LABELVALUELIMITSBAR</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)">TEMP1</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)">SUBSETTING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEXTCOLOR</span><span class="token plain"> green </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Change the label's text to green</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
102
105
|
<p><img decoding=async loading=lazy alt=SUBSETTING src=/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png width=766 height=282 class=img__Ss2></p>
|
|
103
106
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=named_widget>NAMED_WIDGET<a href=#named_widget class=hash-link aria-label="Direct link to NAMED_WIDGET" title="Direct link to NAMED_WIDGET"></a></h2>
|
|
104
107
|
<p><strong>Name a widget to allow access to it via the getNamedWidget method</strong></p>
|
|
@@ -106,7 +109,7 @@ unique settings which are documented under that specific widget.</p>
|
|
|
106
109
|
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>warning</div><div class=admonitionContent_bl22><p>getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget</div></div>
|
|
107
110
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Widget Name<td>The unique name applied to the following widget instance. Names must be unique per screen.<td>True<tr><td>Widget Type<td>One of the widget types listed in Widget Descriptions<td>True<tr><td>Widget Parameters<td>The unique parameters for the given widget type<td>True</table>
|
|
108
111
|
<p>Example Usage:</p>
|
|
109
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
112
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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><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)">"Push"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"screen.getNamedWidget('DURATION').text()"</span><br></span></code></pre></div></div>
|
|
110
113
|
<p><img decoding=async loading=lazy alt=NAMED_WIDGET src=/tools/staticdocs/assets/images/named_widget-37362db8e310e5639be849d729fd637677f72330d676da4cd6baafc4b961331c.png width=368 height=248 class=img__Ss2></p>
|
|
111
114
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=layout-widgets>Layout Widgets<a href=#layout-widgets class=hash-link aria-label="Direct link to Layout Widgets" title="Direct link to Layout Widgets"></a></h2>
|
|
112
115
|
<hr>
|
|
@@ -116,42 +119,42 @@ unique settings which are documented under that specific widget.</p>
|
|
|
116
119
|
<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
120
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
118
121
|
<p>Example Usage:</p>
|
|
119
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
122
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VERTICAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain">px</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)">"TEST"</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)">"SCREEN"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
120
123
|
<p><img decoding=async loading=lazy alt=VERTICAL src=/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png width=386 height=256 class=img__Ss2></p>
|
|
121
124
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=verticalbox>VERTICALBOX<a href=#verticalbox class=hash-link aria-label="Direct link to VERTICALBOX" title="Direct link to VERTICALBOX"></a></h3>
|
|
122
125
|
<p><strong>Places the widgets it encapsulates vertically inside a thin border</strong></p>
|
|
123
126
|
<p>The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally</p>
|
|
124
127
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Title<td>Text to place within the border to label the box<td>False<tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
125
128
|
<p>Example Usage:</p>
|
|
126
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
129
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VERTICALBOX</span><span class="token plain"> Info</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)">SUBSETTING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> border </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"1px dashed green"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TEST"</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)">"SCREEN"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
127
130
|
<p><img decoding=async loading=lazy alt=VERTICALBOX src=/tools/staticdocs/assets/images/verticalbox-75738427d398302986b52afb373acef11abf3a24f60d20b8cca442688054b22b.png width=340 height=264 class=img__Ss2></p>
|
|
128
131
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=horizontal>HORIZONTAL<a href=#horizontal class=hash-link aria-label="Direct link to HORIZONTAL" title="Direct link to HORIZONTAL"></a></h3>
|
|
129
132
|
<p><strong>Places the widgets it encapsulates horizontally</strong></p>
|
|
130
133
|
<p>The HORIZONTAL widget sizes itself to fit its contents</p>
|
|
131
134
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
132
135
|
<p>Example Usage:</p>
|
|
133
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
136
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">HORIZONTAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TEST"</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)">"SCREEN"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
134
137
|
<p><img decoding=async loading=lazy alt=HORIZONTAL src=/tools/staticdocs/assets/images/horizontal-11de51b6fc8baf057ca4f38a7f54a5302b58f30099331c22a074f012e53497aa.png width=1084 height=552 class=img__Ss2></p>
|
|
135
138
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=horizontalbox>HORIZONTALBOX<a href=#horizontalbox class=hash-link aria-label="Direct link to HORIZONTALBOX" title="Direct link to HORIZONTALBOX"></a></h3>
|
|
136
139
|
<p><strong>Places the widgets it encapsulates horizontally inside a thin border</strong></p>
|
|
137
140
|
<p>The HORIZONTALBOX widget sizes itself to fit its contents</p>
|
|
138
141
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Title<td>Text to place within the border to label the box<td>False<tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
139
142
|
<p>Example Usage:</p>
|
|
140
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
143
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">HORIZONTALBOX</span><span class="token plain"> Info </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">SUBSETTING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> text</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">align </span><span class="token constant" style="color:rgb(130, 170, 255)">CENTER</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)">SUBSETTING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> border </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"1px solid blue"</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)">"TEST"</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)">"SCREEN"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
141
144
|
<p><img decoding=async loading=lazy alt=HORIZONTALBOX src=/tools/staticdocs/assets/images/horizontalbox-085c91cebe26fdd5f85b467556607dd4631da5bccabd84fb164d1f46e45e60c9.png width=340 height=236 class=img__Ss2></p>
|
|
142
145
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=matrixbycolumns>MATRIXBYCOLUMNS<a href=#matrixbycolumns class=hash-link aria-label="Direct link to MATRIXBYCOLUMNS" title="Direct link to MATRIXBYCOLUMNS"></a></h3>
|
|
143
146
|
<p><strong>Places the widgets into a table-like matrix</strong></p>
|
|
144
147
|
<p>The MATRIXBYCOLUMNS widget sizes itself to fit its contents</p>
|
|
145
148
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Columns<td>The number of columns to create<td>True<tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
146
149
|
<p>Example Usage:</p>
|
|
147
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
150
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MATRIXBYCOLUMNS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">"COL 1"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"COL 2"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"COL 3"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"100"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"200"</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)">"300"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
148
151
|
<p><img decoding=async loading=lazy alt=MATRIXBYCOLUMNS src=/tools/staticdocs/assets/images/matrixbycolumns-74a67f236a97fffbdf7251fc98da2302a92df20ad16793a1617bc6f77380c9f6.png width=492 height=288 class=img__Ss2></p>
|
|
149
152
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=scrollwindow>SCROLLWINDOW<a href=#scrollwindow class=hash-link aria-label="Direct link to SCROLLWINDOW" title="Direct link to SCROLLWINDOW"></a></h3>
|
|
150
153
|
<p><strong>Places the widgets inside of it into a scrollable area</strong></p>
|
|
151
154
|
<p>The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained</p>
|
|
152
155
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Height<td>Maximum height of the scroll window in pixels (default = 200)<td>False<tr><td>Margin<td>Margin between widgets (default = 0px)<td>False</table>
|
|
153
156
|
<p>Example Usage:</p>
|
|
154
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
157
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SCROLLWINDOW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"100"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"200"</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)">"300"</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)">"400"</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)">"500"</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)">"600"</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)">"700"</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)">"800"</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)">"900"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
155
158
|
<p><img decoding=async loading=lazy alt=SCROLLWINDOW src=/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png width=380 height=298 class=img__Ss2></p>
|
|
156
159
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tabbook>TABBOOK<a href=#tabbook class=hash-link aria-label="Direct link to TABBOOK" title="Direct link to TABBOOK"></a></h3>
|
|
157
160
|
<p><strong>Creates a tabbed area in which to place TABITEM widgets</strong></p>
|
|
@@ -159,13 +162,13 @@ unique settings which are documented under that specific widget.</p>
|
|
|
159
162
|
<p><strong>Creates a VERTICAL layout tab into which to place widgets</strong></p>
|
|
160
163
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Tab text<td>Text to display in the tab<td>True</table>
|
|
161
164
|
<p>Example Usage:</p>
|
|
162
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
165
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TABBOOK</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)">TABITEM</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Tab 1"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"100"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"200"</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)">TABITEM</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Tab 2"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"300"</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)">"400"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
163
166
|
<p><img decoding=async loading=lazy alt=TABITEM src=/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png width=402 height=322 class=img__Ss2></p>
|
|
164
167
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=iframe>IFRAME<a href=#iframe class=hash-link aria-label="Direct link to IFRAME" title="Direct link to IFRAME"></a></h3>
|
|
165
168
|
<p><strong>Open external tools in an Iframe within OpenC3</strong></p>
|
|
166
169
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>URL<td>The path to the page to display in the iframe<td>True<tr><td>Width<td>Width of the widget<td>False<tr><td>Height<td>Height of the widget<td>False</table>
|
|
167
170
|
<p>Example Usage:</p>
|
|
168
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
171
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">IFRAME</span><span class="token plain"> https</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">openc3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">com </span><span class="token number" style="color:rgb(247, 140, 108)">900</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">450</span><br></span></code></pre></div></div>
|
|
169
172
|
<p><img decoding=async loading=lazy alt=IFRAME src=/tools/staticdocs/assets/images/iframe-30d5a4104336b84d18ba538d668978a7986679431a7fe1fd0e3179fea08c074f.png width=1826 height=976 class=img__Ss2></p>
|
|
170
173
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=decoration-widgets>Decoration Widgets<a href=#decoration-widgets class=hash-link aria-label="Direct link to Decoration Widgets" title="Direct link to Decoration Widgets"></a></h2>
|
|
171
174
|
<hr>
|
|
@@ -175,24 +178,24 @@ unique settings which are documented under that specific widget.</p>
|
|
|
175
178
|
<p>Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget.</p>
|
|
176
179
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Text<td>Text to display on the label<td>True</table>
|
|
177
180
|
<p>Example Usage:</p>
|
|
178
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
181
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Note: This is only a warning"</span><br></span></code></pre></div></div>
|
|
179
182
|
<p><img decoding=async loading=lazy alt=LABEL src=/tools/staticdocs/assets/images/label-25a3052a497d0db7ebf84c788baedcd01d34f4b423aceee53d6d83639a128e82.png width=468 height=162 class=img__Ss2></p>
|
|
180
183
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=horizontalline>HORIZONTALLINE<a href=#horizontalline class=hash-link aria-label="Direct link to HORIZONTALLINE" title="Direct link to HORIZONTALLINE"></a></h3>
|
|
181
184
|
<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>
|
|
182
185
|
<p>Example Usage:</p>
|
|
183
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
186
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> Over</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)">HORIZONTALLINE</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"> Under</span><br></span></code></pre></div></div>
|
|
184
187
|
<p><img decoding=async loading=lazy alt=HORIZONTALLINE src=/tools/staticdocs/assets/images/horizontalline-0805762eadcc125ed6584a29a60e7cf8e2d76d13c6243e18eecbaba7a3803128.png width=380 height=240 class=img__Ss2></p>
|
|
185
188
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=title>TITLE<a href=#title class=hash-link aria-label="Direct link to TITLE" title="Direct link to TITLE"></a></h3>
|
|
186
189
|
<p><strong>Displays a large centered title on the screen</strong></p>
|
|
187
190
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Text<td>Text to display<td>True</table>
|
|
188
191
|
<p>Example Usage:</p>
|
|
189
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
192
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TITLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Title"</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)">HORIZONTALLINE</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)">"Label"</span><br></span></code></pre></div></div>
|
|
190
193
|
<p><img decoding=async loading=lazy alt=TITLE src=/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png width=374 height=254 class=img__Ss2></p>
|
|
191
194
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=spacer>SPACER<a href=#spacer class=hash-link aria-label="Direct link to SPACER" title="Direct link to SPACER"></a></h3>
|
|
192
195
|
<p><strong>Places a fixed size spacer in between widgets</strong></p>
|
|
193
196
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Width<td>Width of the spacer in pixels<td>True<tr><td>Height<td>Height of the spacer in pixels<td>True</table>
|
|
194
197
|
<p>Example Usage:</p>
|
|
195
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
198
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VERTICAL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Spacer below"</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)">SPACER</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Spacer above"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
196
199
|
<p><img decoding=async loading=lazy alt=SPACER src=/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png width=366 height=442 class=img__Ss2></p>
|
|
197
200
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=telemetry-widgets>Telemetry Widgets<a href=#telemetry-widgets class=hash-link aria-label="Direct link to Telemetry Widgets" title="Direct link to Telemetry Widgets"></a></h2>
|
|
198
201
|
<hr>
|
|
@@ -201,13 +204,13 @@ unique settings which are documented under that specific widget.</p>
|
|
|
201
204
|
<p><strong>Displays ARRAY data organized into rows and space separated</strong></p>
|
|
202
205
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Width<td>Width of the widget (default = 200)<td>False<tr><td>Height<td>Height of the widget (default = 100)<td>False<tr><td>Format string<td>Format string applied to each array item (default = nil)<td>False<tr><td>Items per row<td>Number of array items per row (default = 4)<td>False<tr><td>Value type<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>False</table>
|
|
203
206
|
<p>Example Usage:</p>
|
|
204
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
207
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY</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)">ARY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">250</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%x"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMATTED</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)">ARRAY</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)">ARY2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WITH_UNITS</span><br></span></code></pre></div></div>
|
|
205
208
|
<p><img decoding=async loading=lazy alt=ARRAY src=/tools/staticdocs/assets/images/array-c0c541246cb3f9e355acc5c510649c29116ce4d6eb8864b9ace48e9958b36421.png width=486 height=418 class=img__Ss2></p>
|
|
206
209
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=arrayplot>ARRAYPLOT<a href=#arrayplot class=hash-link aria-label="Direct link to ARRAYPLOT" title="Direct link to ARRAYPLOT"></a></h3>
|
|
207
210
|
<p><strong>Plot an array of values.</strong></p>
|
|
208
211
|
<p>The item can either be a simple array or a 2D array of x values and y values, e.g. [[x1, x2, x3], [y1, y2, y3]]. If the X_AXIS setting is not specified, the X axis starts with 0 and increments by 1. If the X_AXIS setting is used the x values of a 2D array will be ignored.</p>
|
|
209
212
|
<p>Example Usage:</p>
|
|
210
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
213
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ARRAYPLOT</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)">TITLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Array Data"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">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)">ARY</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)">ITEM</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)">ARY2</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)">SIZE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">600</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">400</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)">X_AXIS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><br></span></code></pre></div></div>
|
|
211
214
|
<p><img decoding=async loading=lazy alt=ARRAYPLOT src=/tools/staticdocs/assets/images/arrayplot-ab4963f7ad4eb1d7ecc646065dd43b4816a06367fa5e07d58b8cf520deff931e.png width=1128 height=1024 class=img__Ss2></p>
|
|
212
215
|
<p>The following settings apply to ARRAYPLOT. They are applied using the SETTING keyword.</p>
|
|
213
216
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=title-1>TITLE<a href=#title-1 class=hash-link aria-label="Direct link to TITLE" title="Direct link to TITLE"></a></h4>
|
|
@@ -241,21 +244,21 @@ unique settings which are documented under that specific widget.</p>
|
|
|
241
244
|
<p><strong>Displays BLOCK data organized into rows and space separated</strong></p>
|
|
242
245
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Width<td>Width of the widget (default = 200)<td>False<tr><td>Height<td>Height of the widget (default = 100)<td>False<tr><td>Format string<td>Format string applied to each array item (default = nil)<td>False<tr><td>Bytes per word<td>Number of bytes per word (default = 4)<td>False<tr><td>Words per row<td>Number of words per row (default = 4<td>False<tr><td>Address format<td>Format for the address printed at the beginning of each line (default = nil which means do not print an address)<td>False<tr><td>Value type<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>False</table>
|
|
243
246
|
<p>Example Usage:</p>
|
|
244
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
247
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">BLOCK</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)">IMAGE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">IMAGE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">620</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"%02X"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%08X:"</span><br></span></code></pre></div></div>
|
|
245
248
|
<p><img decoding=async loading=lazy alt=BLOCK src=/tools/staticdocs/assets/images/block-14583c7d26c1a1c6553435d57015bc5282426f7aa176804867de223009a8d4d7.png width=1272 height=464 class=img__Ss2></p>
|
|
246
249
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=formatvalue>FORMATVALUE<a href=#formatvalue class=hash-link aria-label="Direct link to FORMATVALUE" title="Direct link to FORMATVALUE"></a></h3>
|
|
247
250
|
<p><strong>Displays a box with a formatted value</strong></p>
|
|
248
251
|
<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>
|
|
249
252
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Format string<td>Printf style format string to apply to the telemetry item<td>False<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
250
253
|
<p>Example Usage:</p>
|
|
251
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
254
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">FORMATVALUE</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)">LATEST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESEC</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token number" style="color:rgb(247, 140, 108)">012</span><span class="token plain">u </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</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)">FORMATVALUE</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)">LATEST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token number" style="color:rgb(247, 140, 108)">.2</span><span class="token plain">f </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</span><br></span></code></pre></div></div>
|
|
252
255
|
<p><img decoding=async loading=lazy alt=FORMATVALUE src=/tools/staticdocs/assets/images/formatvalue-8e2ddb6cec177fde1846d333d70168479a3bf67dd2b293764f938726b9e7cdf8.png width=388 height=210 class=img__Ss2></p>
|
|
253
256
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=labelled>LABELLED<a href=#labelled class=hash-link aria-label="Direct link to LABELLED" title="Direct link to LABELLED"></a></h3>
|
|
254
257
|
<p><strong>Displays a LABEL followed by a LED</strong></p>
|
|
255
258
|
<p>See the LED widget for more information</p>
|
|
256
259
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Width<td>Width of the LED circle (default = 15)<td>False<tr><td>Height<td>Height of the LED circle (default = 15)<td>False<tr><td>Justification<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>False</table>
|
|
257
260
|
<p>Example Usage:</p>
|
|
258
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
261
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELLED</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)">PARAMS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE1</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)">LED_COLOR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GOOD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GREEN</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LED_COLOR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BAD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RED</span><br></span></code></pre></div></div>
|
|
259
262
|
<p><img decoding=async loading=lazy alt=LABELLED src=/tools/staticdocs/assets/images/labelled-b8d0f0a157f48e1fa98511f9177f962e69d1e0e8c24b37cf9f355671f9d13ab8.png width=372 height=154 class=img__Ss2></p>
|
|
260
263
|
<p>The following settings apply to LABELLED. They are applied using the SETTING keyword.</p>
|
|
261
264
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=led_color>LED_COLOR<a href=#led_color class=hash-link aria-label="Direct link to LED_COLOR" title="Direct link to LED_COLOR"></a></h4>
|
|
@@ -265,19 +268,19 @@ unique settings which are documented under that specific widget.</p>
|
|
|
265
268
|
<p><strong>Displays a LABEL with the item name followed by a PROGRESSBAR</strong></p>
|
|
266
269
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Scale factor<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>False<tr><td>Width<td>Width of the progress bar (default = 80 pixels<td>False<tr><td>Value type<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>False</table>
|
|
267
270
|
<p>Example Usage:</p>
|
|
268
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
271
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELPROGRESSBAR</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)">ADCS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POSPROGRESS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</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)">LABELPROGRESSBAR</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)">ADCS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POSPROGRESS</span><br></span></code></pre></div></div>
|
|
269
272
|
<p><img decoding=async loading=lazy alt=LABELPROGRESSBAR src=/tools/staticdocs/assets/images/labelprogressbar-c3412db92b2f4e6af20233b085ee20915414d6c4da371398a3e8f36b84971cc7.png width=728 height=230 class=img__Ss2></p>
|
|
270
273
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=labelvalue>LABELVALUE<a href=#labelvalue class=hash-link aria-label="Direct link to LABELVALUE" title="Direct link to LABELVALUE"></a></h3>
|
|
271
274
|
<p><strong>Displays a LABEL with the item name followed by a VALUE</strong></p>
|
|
272
275
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
273
276
|
<p>Example Usage:</p>
|
|
274
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
277
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">LATEST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESEC</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">LATEST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECT_TYPE</span><br></span></code></pre></div></div>
|
|
275
278
|
<p><img decoding=async loading=lazy alt=LABELVALUE src=/tools/staticdocs/assets/images/labelvalue-db97724272df4815b4ecc397974f91a62c31108b98ef0657716c670ca8128051.png width=592 height=218 class=img__Ss2></p>
|
|
276
279
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=labelvaluedesc>LABELVALUEDESC<a href=#labelvaluedesc class=hash-link aria-label="Direct link to LABELVALUEDESC" title="Direct link to LABELVALUEDESC"></a></h3>
|
|
277
280
|
<p><strong>Displays a LABEL with the items description followed by a VALUE</strong></p>
|
|
278
281
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Description<td>The description to display in the label (default is to display the description text associated with the telemetry item)<td>False<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
279
282
|
<p>Example Usage:</p>
|
|
280
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
283
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUEDESC</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)">TEMP1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Temperature number 1"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">LABELVALUEDESC</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><br></span></code></pre></div></div>
|
|
281
284
|
<p><img decoding=async loading=lazy alt=LABELVALUEDESC src=/tools/staticdocs/assets/images/labelvaluedesc-2e174a9f3443ba971683dea9a33f8aa66d0248fb92a3aff41ec26b7424b5e68c.png width=766 height=218 class=img__Ss2></p>
|
|
282
285
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=labelvaluelimitsbar>LABELVALUELIMITSBAR<a href=#labelvaluelimitsbar class=hash-link aria-label="Direct link to LABELVALUELIMITSBAR" title="Direct link to LABELVALUELIMITSBAR"></a></h3>
|
|
283
286
|
<p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets</strong></p>
|
|
@@ -286,20 +289,20 @@ unique settings which are documented under that specific widget.</p>
|
|
|
286
289
|
<p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets</strong></p>
|
|
287
290
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
288
291
|
<p>Example Usage:</p>
|
|
289
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
292
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUELIMITSCOLUMN</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">LABELVALUELIMITSCOLUMN</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
290
293
|
<p><img decoding=async loading=lazy alt=LABELVALUELIMITSCOLUMN src=/tools/staticdocs/assets/images/labelvaluelimitscolumn-47664affa9d88150ce257e90d32c61b314d7f0b6aa6da4f5e49152be2cce4ef7.png width=430 height=850 class=img__Ss2></p>
|
|
291
294
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=labelvaluerangebar>LABELVALUERANGEBAR<a href=#labelvaluerangebar class=hash-link aria-label="Direct link to LABELVALUERANGEBAR" title="Direct link to LABELVALUERANGEBAR"></a></h3>
|
|
292
295
|
<p><strong>Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets</strong></p>
|
|
293
296
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Low Value<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>True<tr><td>High Value<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>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False<tr><td>Width<td>Width of the range bar (default = 160)<td>False<tr><td>Height<td>Height of the range bar (default = 25)<td>False</table>
|
|
294
297
|
<p>Example Usage:</p>
|
|
295
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
298
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELVALUERANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100000</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">40</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)">LABELVALUERANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">120</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">120</span><br></span></code></pre></div></div>
|
|
296
299
|
<p><img decoding=async loading=lazy alt=LABELVALUERANGEBAR src=/tools/staticdocs/assets/images/labelvaluerangebar-641eba160b8ef7872557584de92f046d9e4411fae3280781f9b049265cc6dd52.png width=950 height=226 class=img__Ss2></p>
|
|
297
300
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=led>LED<a href=#led class=hash-link aria-label="Direct link to LED" title="Direct link to LED"></a></h3>
|
|
298
301
|
<p><strong>Displays a LED which changes color based on telemetry values</strong></p>
|
|
299
302
|
<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. See LIMITSCOLOR for a widget that displays a circle depicting the limits color of an item.</p>
|
|
300
303
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Width<td>Width of the LED circle (default = 15)<td>False<tr><td>Height<td>Height of the LED circle (default = 15)<td>False</table>
|
|
301
304
|
<p>Example Usage:</p>
|
|
302
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
305
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LED</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)">PARAMS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE5</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">25</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Ellipse</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)">LED_COLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GREEN</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LED_COLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RED</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)">LED_COLOR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">YELLOW</span><br></span></code></pre></div></div>
|
|
303
306
|
<p><img decoding=async loading=lazy alt=LED src=/tools/staticdocs/assets/images/led-d333a6c7e8b1bad13b7775142c74f94b1829ddedd38814d606b2d00e76707751.png width=370 height=130 class=img__Ss2></p>
|
|
304
307
|
<p>The following settings apply to LED. They are applied using the SETTING keyword.</p>
|
|
305
308
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=led_color-1>LED_COLOR<a href=#led_color-1 class=hash-link aria-label="Direct link to LED_COLOR" title="Direct link to LED_COLOR"></a></h4>
|
|
@@ -309,43 +312,43 @@ unique settings which are documented under that specific widget.</p>
|
|
|
309
312
|
<p><strong>Displays an item's current value within its colored limits horizontally</strong></p>
|
|
310
313
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Width<td>Width of the range bar (default = 160)<td>False<tr><td>Height<td>Height of the range bar (default = 25)<td>False</table>
|
|
311
314
|
<p>Example Usage:</p>
|
|
312
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
315
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LIMITSBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">LIMITSBAR</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
313
316
|
<p><img decoding=async loading=lazy alt=LIMITSBAR src=/tools/staticdocs/assets/images/limitsbar-4f2758f846f6f8a1add81aeaf3b58e071792a6d2ccae9eb504e9c07ab8f8dae1.png width=450 height=246 class=img__Ss2></p>
|
|
314
317
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=limitscolumn>LIMITSCOLUMN<a href=#limitscolumn class=hash-link aria-label="Direct link to LIMITSCOLUMN" title="Direct link to LIMITSCOLUMN"></a></h3>
|
|
315
318
|
<p><strong>Displays an item's current value within its colored limits vertically</strong></p>
|
|
316
319
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Width<td>Width of the range bar (default = 160)<td>False<tr><td>Height<td>Height of the range bar (default = 25)<td>False</table>
|
|
317
320
|
<p>Example Usage:</p>
|
|
318
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
321
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LIMITSCOLUMN</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</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)">LIMITSCOLUMN</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
319
322
|
<p><img decoding=async loading=lazy alt=LIMITSCOLUMN src=/tools/staticdocs/assets/images/limitscolumn-743800180e9558c86a4f5c5d949e2b8355420a98c85ef98a3320b09defa21fe6.png width=372 height=724 class=img__Ss2></p>
|
|
320
323
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=limitscolor>LIMITSCOLOR<a href=#limitscolor class=hash-link aria-label="Direct link to LIMITSCOLOR" title="Direct link to LIMITSCOLOR"></a></h3>
|
|
321
324
|
<p><strong>Displays a circle depicting the limits color of an item. See LED for a widget that displays a circle which changes to an arbitrary color based on telemetry values.</strong></p>
|
|
322
325
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Radius<td>Radius of the circle (default is 10)<td>False<tr><td>Item Name Display<td>Show the full item name, e.g. TGT PKT ITEM (true), no item name (nil or none) or just the item name (false). Default is false.<td>False</table>
|
|
323
326
|
<p>Example Usage:</p>
|
|
324
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
327
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">LIMITSCOLOR</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NIL</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># No label</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)">'1st Temp'</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)">LIMITSCOLOR</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)">TEMP2</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Default is label with just item name</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)">LIMITSCOLOR</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)">TEMP3</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Full TGT/PKT/ITEM label</span><br></span></code></pre></div></div>
|
|
325
328
|
<p><img decoding=async loading=lazy alt=LIMITSCOLOR src=/tools/staticdocs/assets/images/limitscolor-32147ddf199a0f1cb68aae5992356bbd745074821e5244d913494a4ad0b638f5.png width=498 height=284 class=img__Ss2></p>
|
|
326
329
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=valuelimitsbar>VALUELIMITSBAR<a href=#valuelimitsbar class=hash-link aria-label="Direct link to VALUELIMITSBAR" title="Direct link to VALUELIMITSBAR"></a></h3>
|
|
327
330
|
<p><strong>Displays an item VALUE followed by LIMITSBAR</strong></p>
|
|
328
331
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
329
332
|
<p>Example Usage:</p>
|
|
330
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
333
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALUELIMITSBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">VALUELIMITSBAR</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
331
334
|
<p><img decoding=async loading=lazy alt=VALUELIMITSBAR src=/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png width=746 height=218 class=img__Ss2></p>
|
|
332
335
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=valuelimitscolumn>VALUELIMITSCOLUMN<a href=#valuelimitscolumn class=hash-link aria-label="Direct link to VALUELIMITSCOLUMN" title="Direct link to VALUELIMITSCOLUMN"></a></h3>
|
|
333
336
|
<p><strong>Displays an item VALUE followed by LIMITSCOLUMN</strong></p>
|
|
334
337
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 8)<td>False</table>
|
|
335
338
|
<p>Example Usage:</p>
|
|
336
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
339
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALUELIMITSCOLUMN</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">VALUELIMITSCOLUMN</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
337
340
|
<p><img decoding=async loading=lazy alt=VALUELIMITSCOLUMN src=/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png width=434 height=706 class=img__Ss2></p>
|
|
338
341
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=valuerangebar>VALUERANGEBAR<a href=#valuerangebar class=hash-link aria-label="Direct link to VALUERANGEBAR" title="Direct link to VALUERANGEBAR"></a></h3>
|
|
339
342
|
<p><strong>Displays an item VALUE followed by RANGEBAR</strong></p>
|
|
340
343
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Low Value<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>True<tr><td>High Value<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>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False<tr><td>Width<td>Width of the range bar (default = 160)<td>False<tr><td>Height<td>Height of the range bar (default = 25)<td>False</table>
|
|
341
344
|
<p>Example Usage:</p>
|
|
342
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
345
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALUERANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100000</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">40</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)">VALUERANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">120</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">120</span><br></span></code></pre></div></div>
|
|
343
346
|
<p><img decoding=async loading=lazy alt=VALUERANGEBAR src=/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png width=576 height=260 class=img__Ss2></p>
|
|
344
347
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=linegraph>LINEGRAPH<a href=#linegraph class=hash-link aria-label="Direct link to LINEGRAPH" title="Direct link to LINEGRAPH"></a></h3>
|
|
345
348
|
<p><strong>Displays a line graph of a telemetry item</strong></p>
|
|
346
349
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class=values>RAW, CONVERTED</span><td>False<tr><td>Reduced<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>False<tr><td>Reduced Type<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>False</table>
|
|
347
350
|
<p>Example Usage:</p>
|
|
348
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
351
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LINEGRAPH</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)">TEMP1</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)">ITEM</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)">ADCS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">Q1</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Add additional item to graph</span><br></span></code></pre></div></div>
|
|
349
352
|
<p><img decoding=async loading=lazy alt=LINEGRAPH src=/tools/staticdocs/assets/images/linegraph-dc3cca59601beb3ea551bbd05e4e09b6cfabd1a7cbc93b757a7d4b22c478a75b.png width=848 height=822 class=img__Ss2></p>
|
|
350
353
|
<p>The following settings apply to LINEGRAPH. They are applied using the SETTING keyword.</p>
|
|
351
354
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=item-1>ITEM<a href=#item-1 class=hash-link aria-label="Direct link to ITEM" title="Direct link to ITEM"></a></h4>
|
|
@@ -373,7 +376,7 @@ unique settings which are documented under that specific widget.</p>
|
|
|
373
376
|
<p><strong>Displays a sparkline graph (no cursor, scale or legend) of a telemetry item</strong></p>
|
|
374
377
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class=values>RAW, CONVERTED</span><td>False<tr><td>Reduced<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>False<tr><td>Reduced Type<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>False</table>
|
|
375
378
|
<p>Example Usage:</p>
|
|
376
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
379
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SPARKLINE</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)">TEMP1</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)">SIZE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">400</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HISTORY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">30</span><span class="token plain">s </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Add 30 seconds of data into graph</span><br></span></code></pre></div></div>
|
|
377
380
|
<p><img decoding=async loading=lazy alt=SPARKLINE src=/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png width=858 height=202 class=img__Ss2></p>
|
|
378
381
|
<p>The following settings apply to SPARKLINE. They are applied using the SETTING keyword.</p>
|
|
379
382
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=item-2>ITEM<a href=#item-2 class=hash-link aria-label="Direct link to ITEM" title="Direct link to ITEM"></a></h4>
|
|
@@ -401,7 +404,7 @@ unique settings which are documented under that specific widget.</p>
|
|
|
401
404
|
<p><strong>Displays a LABEL with the item name followed by a SPARKLINE</strong></p>
|
|
402
405
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class=values>RAW, CONVERTED</span><td>False<tr><td>Reduced<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>False<tr><td>Reduced Type<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>False</table>
|
|
403
406
|
<p>Example Usage:</p>
|
|
404
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
407
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">LABELSPARKLINE</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)">TEMP1</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)">HISTORY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain">m </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Add 5 minutes of data into graph</span><br></span></code></pre></div></div>
|
|
405
408
|
<p><img decoding=async loading=lazy alt=LABELSPARKLINE src=/tools/staticdocs/assets/images/labelsparkline-5985a0f034a5d2fb54b040612178ac9f0d5476eb76ca7e04cacc2618a9970c69.png width=442 height=154 class=img__Ss2></p>
|
|
406
409
|
<p>The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword.</p>
|
|
407
410
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=item-3>ITEM<a href=#item-3 class=hash-link aria-label="Direct link to ITEM" title="Direct link to ITEM"></a></h4>
|
|
@@ -429,44 +432,44 @@ unique settings which are documented under that specific widget.</p>
|
|
|
429
432
|
<p><strong>Display a base64 image from a TLM packet</strong></p>
|
|
430
433
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name to pull the CONVERTED value from. If additional processing (base64 encoding) is needed consider using a DERIVED item.<td>True<tr><td>Format<td>The image format of the base64 data (e.g. jpg, png, etc)<td>True</table>
|
|
431
434
|
<p>Example Usage:</p>
|
|
432
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
435
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">IMAGEVIEWER</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)">IMAGE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">IMAGE</span><span class="token plain"> jpg</span><br></span></code></pre></div></div>
|
|
433
436
|
<p><img decoding=async loading=lazy alt=IMAGEVIEWER src=/tools/staticdocs/assets/images/imageviewer-6149159e29a35cd6694926b344836ce034ce17cc019537028a80d95460eec405.png width=426 height=476 class=img__Ss2></p>
|
|
434
437
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=progressbar>PROGRESSBAR<a href=#progressbar class=hash-link aria-label="Direct link to PROGRESSBAR" title="Direct link to PROGRESSBAR"></a></h3>
|
|
435
438
|
<p><strong>Displays a progress bar that is useful for displaying percentages</strong></p>
|
|
436
439
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Scale factor<td>Value to multiple the telemetry item by before displaying the in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.<td>False<tr><td>Width<td>Width of the progress bar (default = 100 pixels)<td>False<tr><td>Value type<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>False</table>
|
|
437
440
|
<p>Example Usage:</p>
|
|
438
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
441
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">PROGRESSBAR</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)">ADCS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POSPROGRESS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</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)">PROGRESSBAR</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)">ADCS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">POSPROGRESS</span><br></span></code></pre></div></div>
|
|
439
442
|
<p><img decoding=async loading=lazy alt=PROGRESSBAR src=/tools/staticdocs/assets/images/progressbar-cc1095369de0d483c4a9b07ad3a76f9e966990b2aa68b2bc8177d7130ed382a7.png width=452 height=208 class=img__Ss2></p>
|
|
440
443
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=rangebar>RANGEBAR<a href=#rangebar class=hash-link aria-label="Direct link to RANGEBAR" title="Direct link to RANGEBAR"></a></h3>
|
|
441
444
|
<p><strong>Displays a custom range bar displaying the item value</strong></p>
|
|
442
445
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Low Value<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>True<tr><td>High Value<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>True<tr><td>Value type<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>False<tr><td>Width<td>Width of the range bar (default = 100)<td>False<tr><td>Height<td>Height of the range bar (default = 25)<td>False</table>
|
|
443
446
|
<p>Example Usage:</p>
|
|
444
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
447
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">RANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100000</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">RANGEBAR</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)">TEMP1</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><br></span></code></pre></div></div>
|
|
445
448
|
<p><img decoding=async loading=lazy alt=RANGEBAR src=/tools/staticdocs/assets/images/rangebar-ceae5a30609ab12625e29fd479e88fb3ba16eb12879976edc807da87547a275d.png width=438 height=288 class=img__Ss2></p>
|
|
446
449
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=rollup>ROLLUP<a href=#rollup class=hash-link aria-label="Direct link to ROLLUP" title="Direct link to ROLLUP"></a></h3>
|
|
447
450
|
<p><div class=right>(Since 5.17.1)</div><strong>Displays a notification icon which changes color based on a rollup telemetry</strong><p></p>
|
|
448
451
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Icon name<td>The astro UX icon to display. Valid choices are 'astro' icons taken from <a href=https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json target=_blank rel="noopener noreferrer">https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json</a>.<td>True<tr><td>Icon label<td>Text to apply to the icon label<td>False<tr><td>Icon sublabel<td>Text to apply to the icon sublabel<td>False</table>
|
|
449
452
|
<p>Example Usage:</p>
|
|
450
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
453
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ROLLUP</span><span class="token plain"> satellite</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">transmit </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"SAT 1"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Details"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Screen to open on click</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)">SCREEN</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)">HS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Telemetry items to rollup status</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)">TLM</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)">TEMP1</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)">TLM</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)">TEMP2</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)">ROLLUP</span><span class="token plain"> antenna </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"GND 2"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Location"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Screen to open on click</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)">SCREEN</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)">HS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Telemetry items to rollup status</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)">TLM</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)">TEMP3</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)">TLM</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)">TEMP4</span><br></span></code></pre></div></div>
|
|
451
454
|
<p><img decoding=async loading=lazy alt=ROLLUP src=/tools/staticdocs/assets/images/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png width=378 height=402 class=img__Ss2></p>
|
|
452
455
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=signal>SIGNAL<a href=#signal class=hash-link aria-label="Direct link to SIGNAL" title="Direct link to SIGNAL"></a></h3>
|
|
453
456
|
<p><div class=right>(Since 5.17.2)</div><strong>Displays a cellular signal icon which changes based on telemetry value</strong><p></p>
|
|
454
457
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class=values>RAW, CONVERTED</span><td>False</table>
|
|
455
458
|
<p>Example Usage:</p>
|
|
456
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
459
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SIGNAL</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)">TEMP1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Screen to open on click</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)">SCREEN</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)">HS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Values to compare when setting the 1-bar, 2-bar and 3-bar icons</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Default is 30, 60, 90 (e.g. 0 to 100 range)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Value < -50 display no bars</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Value >= -50 and < 0 displays 1 bar</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Value >= 0 and < 50 displays 2 bars</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Value >= 50 displays 5 bars</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)">RANGE</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><br></span></code></pre></div></div>
|
|
457
460
|
<p><img decoding=async loading=lazy alt=SIGNAL src=/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png width=366 height=128 class=img__Ss2></p>
|
|
458
461
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=textbox>TEXTBOX<a href=#textbox class=hash-link aria-label="Direct link to TEXTBOX" title="Direct link to TEXTBOX"></a></h3>
|
|
459
462
|
<p><strong>Provides a large box for multiline text</strong></p>
|
|
460
463
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Width<td>Width of the textbox in px (default = 200)<td>False<tr><td>Height<td>Height of the textbox in px (default = 200)<td>False</table>
|
|
461
464
|
<p>Example Usage:</p>
|
|
462
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
465
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TEXTBOX</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)">PACKET_TIMEFORMATTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">150</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">70</span><br></span></code></pre></div></div>
|
|
463
466
|
<p><img decoding=async loading=lazy alt=TEXTBOX src=/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png width=376 height=226 class=img__Ss2></p>
|
|
464
467
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=value>VALUE<a href=#value class=hash-link aria-label="Direct link to VALUE" title="Direct link to VALUE"></a></h3>
|
|
465
468
|
<p><strong>Displays a box with a telemetry item value</strong></p>
|
|
466
469
|
<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>
|
|
467
470
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<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>False<tr><td>Number of characters<td>The number of characters wide to make the value box (default = 12)<td>False</table>
|
|
468
471
|
<p>Example Usage:</p>
|
|
469
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
472
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">VALUE</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)">TEMP1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</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)">VALUE</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)">TEMP1</span><br></span></code></pre></div></div>
|
|
470
473
|
<p><img decoding=async loading=lazy alt=VALUE src=/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png width=462 height=206 class=img__Ss2></p>
|
|
471
474
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=interactive-widgets>Interactive Widgets<a href=#interactive-widgets class=hash-link aria-label="Direct link to Interactive Widgets" title="Direct link to Interactive Widgets"></a></h2>
|
|
472
475
|
<hr>
|
|
@@ -495,28 +498,28 @@ the name of the script, whether to open the script in the foreground of Script R
|
|
|
495
498
|
environment variables. For example: <code>runScript('INST/procedures/script.rb', false, {'VAR': 'VALUE'})</code></p>
|
|
496
499
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Button Text<td>Text displayed on the button<td>True<tr><td>Button Code<td>Javascript code to execute when the button is pressed<td>True</table>
|
|
497
500
|
<p>Example Usage:</p>
|
|
498
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
501
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 NORMAL, DURATION 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)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Run Checks'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'runScript("INST/procedures/checks.rb")'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># More complex example with background checkbox and env vars</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)">SCRIPTNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMBOBOX</span><span class="token plain"> collect</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb checks</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></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)">BG</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)">'Background'</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)">'Run Script'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"var script=screen.getNamedWidget('SCRIPTNAME').text();"</span><span class="token plain"> \</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Set an environment variable to be used by the script as ENV['TYPE']</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"var env = {}; env['TYPE'] = 'TEST';"</span><span class="token plain"> \</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked(), env)"</span><br></span></code></pre></div></div>
|
|
499
502
|
<p><img decoding=async loading=lazy alt=BUTTON src=/tools/staticdocs/assets/images/button-3f6fd69518f4b2c60b15605ca607cda8b596d4d5e804b867f09f750a47b6cbad.png width=382 height=502 class=img__Ss2></p>
|
|
500
503
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=checkbutton>CHECKBUTTON<a href=#checkbutton class=hash-link aria-label="Direct link to CHECKBUTTON" title="Direct link to CHECKBUTTON"></a></h3>
|
|
501
504
|
<p><strong>Displays a check box</strong></p>
|
|
502
505
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
503
506
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Checkbox Text<td>Text displayed next to the checkbox<td>True<tr><td>Checked<td>Whether the initial state of the checkbox is checked (default = false). Do not give a value to make the checkbox unchecked.<td>False</table>
|
|
504
507
|
<p>Example Usage:</p>
|
|
505
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
508
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">NAMED_WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNCHECKED</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)">'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)">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 constant" style="color:rgb(130, 170, 255)">CHECKED</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("CHECK").checked() ? '</span><span class="token plain"> \</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'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 comment" style="color:rgb(99, 119, 119);font-style:italic"># You can programmatically check or uncheck the checkbox</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)">'Check'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'screen.getNamedWidget("CHECK").value = true'</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)">'Uncheck'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'screen.getNamedWidget("CHECK").value = false'</span><br></span></code></pre></div></div>
|
|
506
509
|
<p><img decoding=async loading=lazy alt=CHECKBUTTON src=/tools/staticdocs/assets/images/checkbutton-c263b840dcdbeca5cd886884fe8f24bedac7daac5a0ca224a1fb2cce3e24bdf6.png width=426 height=460 class=img__Ss2></p>
|
|
507
510
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=combobox>COMBOBOX<a href=#combobox class=hash-link aria-label="Direct link to COMBOBOX" title="Direct link to COMBOBOX"></a></h3>
|
|
508
511
|
<p><strong>Displays a drop down list of text items</strong></p>
|
|
509
512
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
510
513
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Option Text 1<td>Text to display in the selection drop down<td>True<tr><td>Option Text n<td>Text to display in the selection drop down<td>False</table>
|
|
511
514
|
<p>Example Usage:</p>
|
|
512
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
515
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">'var type = screen.getNamedWidget("COLLECT_TYPE").text();'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'api.cmd("INST COLLECT with TYPE "+type+", DURATION 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 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><br></span></code></pre></div></div>
|
|
513
516
|
<p><img decoding=async loading=lazy alt=COMBOBOX src=/tools/staticdocs/assets/images/combobox-6c8fa241aa7c5ccf31a42a2373dbd4f6f66d9a063e98ba111d5472b5c8e21590.png width=386 height=268 class=img__Ss2></p>
|
|
514
517
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=date>DATE<a href=#date class=hash-link aria-label="Direct link to DATE" title="Direct link to DATE"></a></h3>
|
|
515
518
|
<p><strong>Displays a date picker</strong></p>
|
|
516
519
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
517
520
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Date label<td>Text to label the data selection ('Date' by default)<td>False</table>
|
|
518
521
|
<p>Example Usage:</p>
|
|
519
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
522
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Alert Date'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'var date = screen.getNamedWidget("DATE").text();'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'alert("Date:"+date)'</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)">DATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATE</span><br></span></code></pre></div></div>
|
|
520
523
|
<p><img decoding=async loading=lazy alt=DATE src=/tools/staticdocs/assets/images/date-d104f822ef7a1b99ade0a334e2e34c27fc6b1d087ed267f13280623a943113ce.png width=372 height=286 class=img__Ss2></p>
|
|
521
524
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=radiogroup>RADIOGROUP<a href=#radiogroup class=hash-link aria-label="Direct link to RADIOGROUP" title="Direct link to RADIOGROUP"></a></h3>
|
|
522
525
|
<p><strong>Creates a group of RADIOBUTTONs</strong></p>
|
|
@@ -527,20 +530,20 @@ environment variables. For example: <code>runScript('INST/procedures/script.rb',
|
|
|
527
530
|
<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>
|
|
528
531
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Text<td>Text to display next to the radio button<td>True</table>
|
|
529
532
|
<p>Example Usage:</p>
|
|
530
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
533
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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)">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 ? "</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"api.cmd('INST ABORT') : api.cmd('INST CLEAR')"</span><br></span></code></pre></div></div>
|
|
531
534
|
<p><img decoding=async loading=lazy alt=RADIOBUTTON src=/tools/staticdocs/assets/images/radiobutton-9151f7cb0dae5120e51e05b5575981c143e19f350e84c7e190d3dd78aa80fae8.png width=364 height=276 class=img__Ss2></p>
|
|
532
535
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=textfield>TEXTFIELD<a href=#textfield class=hash-link aria-label="Direct link to TEXTFIELD" title="Direct link to TEXTFIELD"></a></h3>
|
|
533
536
|
<p><strong>Displays a rectangular box where the user can enter text</strong></p>
|
|
534
537
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Characters<td>Width of the text field in characters (default = 12)<td>False<tr><td>Text<td>Default text to put in the text field (default is blank)<td>False</table>
|
|
535
538
|
<p>Example Usage:</p>
|
|
536
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
539
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 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)">'var dur = screen.getNamedWidget("DURATION").text();'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'api.cmd("INST COLLECT with TYPE NORMAL, DURATION "+dur+"")'</span><br></span></code></pre></div></div>
|
|
537
540
|
<p><img decoding=async loading=lazy alt=TEXTFIELD src=/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png width=370 height=238 class=img__Ss2></p>
|
|
538
541
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=time>TIME<a href=#time class=hash-link aria-label="Direct link to TIME" title="Direct link to TIME"></a></h3>
|
|
539
542
|
<p><strong>Displays a time picker</strong></p>
|
|
540
543
|
<p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p>
|
|
541
544
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time label<td>Text to label the time selection ('Time' by default)<td>False</table>
|
|
542
545
|
<p>Example Usage:</p>
|
|
543
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
546
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'Alert Time'</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'var time = screen.getNamedWidget("TIME").text();'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'alert("Time:"+time)'</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)">TIME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIME</span><br></span></code></pre></div></div>
|
|
544
547
|
<p><img decoding=async loading=lazy alt=TIME src=/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png width=366 height=272 class=img__Ss2></p>
|
|
545
548
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=canvas-widgets>Canvas Widgets<a href=#canvas-widgets class=hash-link aria-label="Direct link to Canvas Widgets" title="Direct link to Canvas Widgets"></a></h2>
|
|
546
549
|
<hr>
|
|
@@ -554,19 +557,19 @@ environment variables. For example: <code>runScript('INST/procedures/script.rb',
|
|
|
554
557
|
<p><strong>Draws text onto the canvas</strong></p>
|
|
555
558
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>X Position<td>X position of the upper-left corner of the text on the canvas<td>True<tr><td>Y Position<td>Y position of the upper-left corner of the text on the canvas<td>True<tr><td>Text<td>Text to draw onto the canvas<td>True<tr><td>Font Size<td>Font size of the text (Default = 12)<td>False<tr><td>Color<td>Color of the text<td>False</table>
|
|
556
559
|
<p>Example Usage:</p>
|
|
557
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
560
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASLABEL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">34</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Label1"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">24</span><span class="token plain"> red</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)">CANVASLABEL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">70</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Label2"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> blue</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
558
561
|
<p><img decoding=async loading=lazy alt=CANVASLABEL src=/tools/staticdocs/assets/images/canvaslabel-68ee99da9ef15924a2b5b41c60ba7de47382d036eece57574411839ff5ec14e4.png width=368 height=278 class=img__Ss2></p>
|
|
559
562
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=canvaslabelvalue>CANVASLABELVALUE<a href=#canvaslabelvalue class=hash-link aria-label="Direct link to CANVASLABELVALUE" title="Direct link to CANVASLABELVALUE"></a></h3>
|
|
560
563
|
<p><strong>Draws the text value of a telemetry item onto the canvas in an optional frame</strong></p>
|
|
561
564
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>X Position<td>X position of the upper-left corner of the text on the canvas<td>True<tr><td>Y Position<td>Y position of the upper-left corner of the text on the canvas<td>True<tr><td>Font Size<td>Font size of the text (Default = 12)<td>False<tr><td>Color<td>Color of the text<td>False<tr><td>Value type<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>False</table>
|
|
562
565
|
<p>Example Usage:</p>
|
|
563
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
566
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASLABELVALUE</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)">TEMP1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">34</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> red</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)">CANVASLABELVALUE</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)">TEMP2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">70</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> blue </span><span class="token constant" style="color:rgb(130, 170, 255)">WITH_UNITS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
564
567
|
<p><img decoding=async loading=lazy alt=CANVASLABELVALUE src=/tools/staticdocs/assets/images/canvaslabelvalue-43254b6647e626939e79ec7e0940e921582039af006e5024c952881ba196b165.png width=436 height=276 class=img__Ss2></p>
|
|
565
568
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=canvasimage>CANVASIMAGE<a href=#canvasimage class=hash-link aria-label="Direct link to CANVASIMAGE" title="Direct link to CANVASIMAGE"></a></h3>
|
|
566
569
|
<p><strong>Displays an image on the canvas</strong></p>
|
|
567
570
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Image filename<td>Name of a image file. The file must be in the plugin's targets/TARGET/public directory.<td>True<tr><td>X Position<td>X position of the upper-left corner of the image on the canvas<td>True<tr><td>Y Position<td>Y position of the upper-left corner of the image on the canvas<td>True</table>
|
|
568
571
|
<p>Example Usage:</p>
|
|
569
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
572
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">250</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">430</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)">CANVASIMAGE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"satellite.png"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">200</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)">SCREEN</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)">HS</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)">CANVASIMAGE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=640&w=426"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">250</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">250</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">150</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
570
573
|
<p><img decoding=async loading=lazy alt=CANVASIMAGE src=/tools/staticdocs/assets/images/canvasimage-6f6f83dc6d777fdff0b820287a96ad171a475fda2896c0a3b678b14984e496fd.png width=536 height=948 class=img__Ss2></p>
|
|
571
574
|
<p>The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword.</p>
|
|
572
575
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=screen-1>SCREEN<a href=#screen-1 class=hash-link aria-label="Direct link to SCREEN" title="Direct link to SCREEN"></a></h4>
|
|
@@ -577,7 +580,7 @@ environment variables. For example: <code>runScript('INST/procedures/script.rb',
|
|
|
577
580
|
<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>
|
|
578
581
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Value type<td>The type of the value to display<br><br>Valid Values: <span class=values>RAW, CONVERTED, FORMATTED, WITH_UNITS</span><td>True<tr><td>Default image filename<td>The default image to display. The file must be in the targets/TARGET/public directory.<td>True<tr><td>X Position<td>X position of the upper-left corner of the image on the canvas<td>True<tr><td>Y Position<td>Y position of the upper-left corner of the image on the canvas<td>True<tr><td>Image width<td>Width of the image (default is 100%)<td>False<tr><td>Image height<td>Height of the image (default is 100%)<td>False</table>
|
|
579
582
|
<p>Example Usage:</p>
|
|
580
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
583
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">230</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">230</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)">CANVASIMAGEVALUE</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)">GROUND1STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONVERTED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ground_error.png"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">180</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">180</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)">IMAGE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONNECTED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ground_on.png"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">IMAGE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNAVAILABLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ground_off.png"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</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)">SCREEN</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)">HS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
581
584
|
<p><img decoding=async loading=lazy alt=CANVASIMAGEVALUE src=/tools/staticdocs/assets/images/canvasimagevalue-8c835310f99cebbb15ad34632c77370cf4cc9b95535040fa4723df8baedb5b57.png width=498 height=546 class=img__Ss2></p>
|
|
582
585
|
<p>The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword.</p>
|
|
583
586
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=image>IMAGE<a href=#image class=hash-link aria-label="Direct link to IMAGE" title="Direct link to IMAGE"></a></h4>
|
|
@@ -590,14 +593,14 @@ environment variables. For example: <code>runScript('INST/procedures/script.rb',
|
|
|
590
593
|
<p><strong>Draws a line onto the canvas</strong></p>
|
|
591
594
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Start X Position<td>X position of the start of the line on the canvas<td>True<tr><td>Start Y Position<td>Y position of the start of the line on the canvas<td>True<tr><td>End X Position<td>X position of the end of the line on the canvas<td>True<tr><td>End Y Position<td>Y position of the end of the line on the canvas<td>True<tr><td>Color<td>Color of the line<td>False<tr><td>Width<td>Width of the line in pixels (default = 1)<td>False</table>
|
|
592
595
|
<p>Example Usage:</p>
|
|
593
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
596
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASLINE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">95</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">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)">CANVASLINE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">45</span><span class="token plain"> green </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASLINE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">95</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">95</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">45</span><span class="token plain"> blue </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
594
597
|
<p><img decoding=async loading=lazy alt=CANVASLINE src=/tools/staticdocs/assets/images/canvasline-c5120da84530d4a60a04d40d5565daede656639808d1a456f430e9404a2d5bad.png width=376 height=180 class=img__Ss2></p>
|
|
595
598
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=canvaslinevalue>CANVASLINEVALUE<a href=#canvaslinevalue class=hash-link aria-label="Direct link to CANVASLINEVALUE" title="Direct link to CANVASLINEVALUE"></a></h3>
|
|
596
599
|
<p><strong>Draws a color changing line onto the canvas</strong></p>
|
|
597
600
|
<p>The line is represented by one of two colors based on the value of the associated telemetry item</p>
|
|
598
601
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target name<td>The target name<td>True<tr><td>Packet name<td>The packet name<td>True<tr><td>Item name<td>The item name<td>True<tr><td>Start X Position<td>X position of the start of the line on the canvas<td>True<tr><td>Start Y Position<td>Y position of the start of the line on the canvas<td>True<tr><td>End X Position<td>X position of the end of the line on the canvas<td>True<tr><td>End Y Position<td>Y position of the end of the line on the canvas<td>True<tr><td>Width<td>Width of the line in pixels (default = 3)<td>False<tr><td>Value type<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>False</table>
|
|
599
602
|
<p>Example Usage:</p>
|
|
600
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
603
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">120</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASLABELVALUE</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)">GROUND1STATUS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> black</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)">CANVASLINEVALUE</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)">GROUND1STATUS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">25</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">25</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RAW</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)">VALUE_EQ</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GREEN</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE_EQ</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RED</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)">CANVASLINEVALUE</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)">GROUND1STATUS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">45</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">45</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)">VALUE_EQ</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CONNECTED</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GREEN</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE_EQ</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNAVAILABLE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RED</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
601
604
|
<p><img decoding=async loading=lazy alt=CANVASLINEVALUE src=/tools/staticdocs/assets/images/canvaslinevalue-5540d10997f723fd09b269b75997452622a3c4333ed4f25628747c1212699255.png width=370 height=184 class=img__Ss2></p>
|
|
602
605
|
<p>The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword.</p>
|
|
603
606
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=value_eq>VALUE_EQ<a href=#value_eq class=hash-link aria-label="Direct link to VALUE_EQ" title="Direct link to VALUE_EQ"></a></h4>
|
|
@@ -607,8 +610,8 @@ environment variables. For example: <code>runScript('INST/procedures/script.rb',
|
|
|
607
610
|
<p><strong>Draws a dot onto the canvas</strong></p>
|
|
608
611
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>X Position<td>X position of the dot<td>True<tr><td>Y Position<td>Y position of the dot<td>True<tr><td>Color<td>Color of the dot<td>True<tr><td>Radius<td>Radius of the dot in pixels<td>True</table>
|
|
609
612
|
<p>Example Usage:</p>
|
|
610
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
613
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CANVAS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CANVASDOT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">15</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BLUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre></div></div>
|
|
611
614
|
<p><img decoding=async loading=lazy alt=CANVASDOT src=/tools/staticdocs/assets/images/canvasdot-d634bed1905d13b0da41200e62781cea6e012b5d68fc914f4c11f512c9c4f7fd.png width=374 height=182 class=img__Ss2></p>
|
|
612
615
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=example-file>Example File<a href=#example-file class=hash-link aria-label="Direct link to Example File" title="Direct link to Example File"></a></h2>
|
|
613
616
|
<p>Example File: TARGET/myscreen.txt</p>
|
|
614
|
-
<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"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/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"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/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><a href=#telemetry-screen-definition-files class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a><li><a href=#new-widgets class="table-of-contents__link toc-highlight">New Widgets</a><li><a href=#screen class="table-of-contents__link toc-highlight">SCREEN</a><li><a href=#end class="table-of-contents__link toc-highlight">END</a><li><a href=#stale_time class="table-of-contents__link toc-highlight">STALE_TIME</a><li><a href=#global_setting class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a><li><a href=#global_subsetting class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a><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><a href=#height class="table-of-contents__link toc-highlight">HEIGHT</a><li><a href=#margin class="table-of-contents__link toc-highlight">MARGIN</a><li><a href=#padding class="table-of-contents__link toc-highlight">PADDING</a><li><a href=#backcolor class="table-of-contents__link toc-highlight">BACKCOLOR</a><li><a href=#textcolor class="table-of-contents__link toc-highlight">TEXTCOLOR</a><li><a href=#bordercolor class="table-of-contents__link toc-highlight">BORDERCOLOR</a><li><a href=#raw class="table-of-contents__link toc-highlight">RAW</a></ul><li><a href=#subsetting class="table-of-contents__link toc-highlight">SUBSETTING</a><li><a href=#named_widget class="table-of-contents__link toc-highlight">NAMED_WIDGET</a><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><a href=#verticalbox class="table-of-contents__link toc-highlight">VERTICALBOX</a><li><a href=#horizontal class="table-of-contents__link toc-highlight">HORIZONTAL</a><li><a href=#horizontalbox class="table-of-contents__link toc-highlight">HORIZONTALBOX</a><li><a href=#matrixbycolumns class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a><li><a href=#scrollwindow class="table-of-contents__link toc-highlight">SCROLLWINDOW</a><li><a href=#tabbook class="table-of-contents__link toc-highlight">TABBOOK</a><li><a href=#tabitem class="table-of-contents__link toc-highlight">TABITEM</a><li><a href=#iframe class="table-of-contents__link toc-highlight">IFRAME</a></ul><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><a href=#horizontalline class="table-of-contents__link toc-highlight">HORIZONTALLINE</a><li><a href=#title class="table-of-contents__link toc-highlight">TITLE</a><li><a href=#spacer class="table-of-contents__link toc-highlight">SPACER</a></ul><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><a href=#arrayplot class="table-of-contents__link toc-highlight">ARRAYPLOT</a><ul><li><a href=#title-1 class="table-of-contents__link toc-highlight">TITLE</a><li><a href=#x_axis class="table-of-contents__link toc-highlight">X_AXIS</a><li><a href=#item class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#block class="table-of-contents__link toc-highlight">BLOCK</a><li><a href=#formatvalue class="table-of-contents__link toc-highlight">FORMATVALUE</a><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></ul><li><a href=#labelprogressbar class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a><li><a href=#labelvalue class="table-of-contents__link toc-highlight">LABELVALUE</a><li><a href=#labelvaluedesc class="table-of-contents__link toc-highlight">LABELVALUEDESC</a><li><a href=#labelvaluelimitsbar class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a><li><a href=#labelvaluelimitscolumn class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a><li><a href=#labelvaluerangebar class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a><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></ul><li><a href=#limitsbar class="table-of-contents__link toc-highlight">LIMITSBAR</a><li><a href=#limitscolumn class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a><li><a href=#limitscolor class="table-of-contents__link toc-highlight">LIMITSCOLOR</a><li><a href=#valuelimitsbar class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a><li><a href=#valuelimitscolumn class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a><li><a href=#valuerangebar class="table-of-contents__link toc-highlight">VALUERANGEBAR</a><li><a href=#linegraph class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href=#item-1 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-1 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-1 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-1 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-1 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-1 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-1 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#sparkline class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href=#item-2 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-2 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-2 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-2 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-2 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-2 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-2 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#labelsparkline class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href=#item-3 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-3 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-3 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-3 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-3 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-3 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-3 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#imageviewer class="table-of-contents__link toc-highlight">IMAGEVIEWER</a><li><a href=#progressbar class="table-of-contents__link toc-highlight">PROGRESSBAR</a><li><a href=#rangebar class="table-of-contents__link toc-highlight">RANGEBAR</a><li><a href=#rollup class="table-of-contents__link toc-highlight">ROLLUP</a><li><a href=#signal class="table-of-contents__link toc-highlight">SIGNAL</a><li><a href=#textbox class="table-of-contents__link toc-highlight">TEXTBOX</a><li><a href=#value class="table-of-contents__link toc-highlight">VALUE</a></ul><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><a href=#checkbutton class="table-of-contents__link toc-highlight">CHECKBUTTON</a><li><a href=#combobox class="table-of-contents__link toc-highlight">COMBOBOX</a><li><a href=#date class="table-of-contents__link toc-highlight">DATE</a><li><a href=#radiogroup class="table-of-contents__link toc-highlight">RADIOGROUP</a><li><a href=#radiobutton class="table-of-contents__link toc-highlight">RADIOBUTTON</a><li><a href=#textfield class="table-of-contents__link toc-highlight">TEXTFIELD</a><li><a href=#time class="table-of-contents__link toc-highlight">TIME</a></ul><li><a href=#canvas-widgets class="table-of-contents__link toc-highlight">Canvas Widgets</a><ul><li><a href=#canvas class="table-of-contents__link toc-highlight">CANVAS</a><li><a href=#canvaslabel class="table-of-contents__link toc-highlight">CANVASLABEL</a><li><a href=#canvaslabelvalue class="table-of-contents__link toc-highlight">CANVASLABELVALUE</a><li><a href=#canvasimage class="table-of-contents__link toc-highlight">CANVASIMAGE</a><ul><li><a href=#screen-1 class="table-of-contents__link toc-highlight">SCREEN</a></ul><li><a href=#canvasimagevalue class="table-of-contents__link toc-highlight">CANVASIMAGEVALUE</a><ul><li><a href=#image class="table-of-contents__link toc-highlight">IMAGE</a><li><a href=#screen-2 class="table-of-contents__link toc-highlight">SCREEN</a></ul><li><a href=#canvasline class="table-of-contents__link toc-highlight">CANVASLINE</a><li><a href=#canvaslinevalue class="table-of-contents__link toc-highlight">CANVASLINEVALUE</a><ul><li><a href=#value_eq class="table-of-contents__link toc-highlight">VALUE_EQ</a></ul><li><a href=#canvasdot class="table-of-contents__link toc-highlight">CANVASDOT</a></ul><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
|
617
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/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"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/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><a href=#telemetry-screen-definition-files class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a><li><a href=#new-widgets class="table-of-contents__link toc-highlight">New Widgets</a><li><a href=#screen class="table-of-contents__link toc-highlight">SCREEN</a><li><a href=#end class="table-of-contents__link toc-highlight">END</a><li><a href=#stale_time class="table-of-contents__link toc-highlight">STALE_TIME</a><li><a href=#global_setting class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a><li><a href=#global_subsetting class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a><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><a href=#height class="table-of-contents__link toc-highlight">HEIGHT</a><li><a href=#margin class="table-of-contents__link toc-highlight">MARGIN</a><li><a href=#padding class="table-of-contents__link toc-highlight">PADDING</a><li><a href=#backcolor class="table-of-contents__link toc-highlight">BACKCOLOR</a><li><a href=#textcolor class="table-of-contents__link toc-highlight">TEXTCOLOR</a><li><a href=#bordercolor class="table-of-contents__link toc-highlight">BORDERCOLOR</a><li><a href=#raw class="table-of-contents__link toc-highlight">RAW</a></ul><li><a href=#subsetting class="table-of-contents__link toc-highlight">SUBSETTING</a><li><a href=#named_widget class="table-of-contents__link toc-highlight">NAMED_WIDGET</a><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><a href=#verticalbox class="table-of-contents__link toc-highlight">VERTICALBOX</a><li><a href=#horizontal class="table-of-contents__link toc-highlight">HORIZONTAL</a><li><a href=#horizontalbox class="table-of-contents__link toc-highlight">HORIZONTALBOX</a><li><a href=#matrixbycolumns class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a><li><a href=#scrollwindow class="table-of-contents__link toc-highlight">SCROLLWINDOW</a><li><a href=#tabbook class="table-of-contents__link toc-highlight">TABBOOK</a><li><a href=#tabitem class="table-of-contents__link toc-highlight">TABITEM</a><li><a href=#iframe class="table-of-contents__link toc-highlight">IFRAME</a></ul><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><a href=#horizontalline class="table-of-contents__link toc-highlight">HORIZONTALLINE</a><li><a href=#title class="table-of-contents__link toc-highlight">TITLE</a><li><a href=#spacer class="table-of-contents__link toc-highlight">SPACER</a></ul><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><a href=#arrayplot class="table-of-contents__link toc-highlight">ARRAYPLOT</a><ul><li><a href=#title-1 class="table-of-contents__link toc-highlight">TITLE</a><li><a href=#x_axis class="table-of-contents__link toc-highlight">X_AXIS</a><li><a href=#item class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#block class="table-of-contents__link toc-highlight">BLOCK</a><li><a href=#formatvalue class="table-of-contents__link toc-highlight">FORMATVALUE</a><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></ul><li><a href=#labelprogressbar class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a><li><a href=#labelvalue class="table-of-contents__link toc-highlight">LABELVALUE</a><li><a href=#labelvaluedesc class="table-of-contents__link toc-highlight">LABELVALUEDESC</a><li><a href=#labelvaluelimitsbar class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a><li><a href=#labelvaluelimitscolumn class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a><li><a href=#labelvaluerangebar class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a><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></ul><li><a href=#limitsbar class="table-of-contents__link toc-highlight">LIMITSBAR</a><li><a href=#limitscolumn class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a><li><a href=#limitscolor class="table-of-contents__link toc-highlight">LIMITSCOLOR</a><li><a href=#valuelimitsbar class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a><li><a href=#valuelimitscolumn class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a><li><a href=#valuerangebar class="table-of-contents__link toc-highlight">VALUERANGEBAR</a><li><a href=#linegraph class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href=#item-1 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-1 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-1 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-1 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-1 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-1 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-1 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#sparkline class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href=#item-2 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-2 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-2 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-2 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-2 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-2 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-2 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#labelsparkline class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href=#item-3 class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#starttime-3 class="table-of-contents__link toc-highlight">STARTTIME</a><li><a href=#history-3 class="table-of-contents__link toc-highlight">HISTORY</a><li><a href=#secondsgraphed-3 class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a><li><a href=#pointssaved-3 class="table-of-contents__link toc-highlight">POINTSSAVED</a><li><a href=#pointsgraphed-3 class="table-of-contents__link toc-highlight">POINTSGRAPHED</a><li><a href=#size-3 class="table-of-contents__link toc-highlight">SIZE</a></ul><li><a href=#imageviewer class="table-of-contents__link toc-highlight">IMAGEVIEWER</a><li><a href=#progressbar class="table-of-contents__link toc-highlight">PROGRESSBAR</a><li><a href=#rangebar class="table-of-contents__link toc-highlight">RANGEBAR</a><li><a href=#rollup class="table-of-contents__link toc-highlight">ROLLUP</a><li><a href=#signal class="table-of-contents__link toc-highlight">SIGNAL</a><li><a href=#textbox class="table-of-contents__link toc-highlight">TEXTBOX</a><li><a href=#value class="table-of-contents__link toc-highlight">VALUE</a></ul><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><a href=#checkbutton class="table-of-contents__link toc-highlight">CHECKBUTTON</a><li><a href=#combobox class="table-of-contents__link toc-highlight">COMBOBOX</a><li><a href=#date class="table-of-contents__link toc-highlight">DATE</a><li><a href=#radiogroup class="table-of-contents__link toc-highlight">RADIOGROUP</a><li><a href=#radiobutton class="table-of-contents__link toc-highlight">RADIOBUTTON</a><li><a href=#textfield class="table-of-contents__link toc-highlight">TEXTFIELD</a><li><a href=#time class="table-of-contents__link toc-highlight">TIME</a></ul><li><a href=#canvas-widgets class="table-of-contents__link toc-highlight">Canvas Widgets</a><ul><li><a href=#canvas class="table-of-contents__link toc-highlight">CANVAS</a><li><a href=#canvaslabel class="table-of-contents__link toc-highlight">CANVASLABEL</a><li><a href=#canvaslabelvalue class="table-of-contents__link toc-highlight">CANVASLABELVALUE</a><li><a href=#canvasimage class="table-of-contents__link toc-highlight">CANVASIMAGE</a><ul><li><a href=#screen-1 class="table-of-contents__link toc-highlight">SCREEN</a></ul><li><a href=#canvasimagevalue class="table-of-contents__link toc-highlight">CANVASIMAGEVALUE</a><ul><li><a href=#image class="table-of-contents__link toc-highlight">IMAGE</a><li><a href=#screen-2 class="table-of-contents__link toc-highlight">SCREEN</a></ul><li><a href=#canvasline class="table-of-contents__link toc-highlight">CANVASLINE</a><li><a href=#canvaslinevalue class="table-of-contents__link toc-highlight">CANVASLINEVALUE</a><ul><li><a href=#value_eq class="table-of-contents__link toc-highlight">VALUE_EQ</a></ul><li><a href=#canvasdot class="table-of-contents__link toc-highlight">CANVASDOT</a></ul><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|