tools/staticdocs/docs/configuration/telemetry-screens.html in openc3-cosmos-tool-docs-5.17.1 vs tools/staticdocs/docs/configuration/telemetry-screens.html in openc3-cosmos-tool-docs-5.18.0

- old
+ new

@@ -1,584 +1,411 @@ <!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"> <head> <meta charset="UTF-8"> -<meta name="generator" content="Docusaurus v3.4.0"> -<title data-rh="true">Screens | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Screens | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><meta data-rh="true" property="og:description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css"> -<script src="/tools/staticdocs/assets/js/runtime~main.2bb31799.js" defer="defer"></script> -<script src="/tools/staticdocs/assets/js/main.c2e2b617.js" defer="defer"></script> +<meta name="generator" content="Docusaurus v3.5.2"> +<title data-rh="true">Screens | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Screens | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><meta data-rh="true" property="og:description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css"> +<script src="/tools/staticdocs/assets/js/runtime~main.12d1e41d.js" defer="defer"></script> +<script src="/tools/staticdocs/assets/js/main.b5390098.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Screens</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Screens</h1></header><p>This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p> <div style="clear:both"></div> -<h2 id="definitions">Definitions</h2> +<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> <table><thead><tr><th>Name</th><th>Definition</th></tr></thead><tbody><tr><td>Widget</td><td>A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task.</td></tr><tr><td>Screen</td><td>A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion.</td></tr><tr><td>Screen Definition File</td><td>A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them.</td></tr></tbody></table> -<h2 id="telemetry-screen-definition-files">Telemetry Screen Definition Files</h2> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="telemetry-screen-definition-files">Telemetry Screen Definition Files<a href="#telemetry-screen-definition-files" class="hash-link" aria-label="Direct link to Telemetry Screen Definition Files" title="Direct link to Telemetry Screen Definition Files">​</a></h2> <p>Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target&#x27;s screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase.</p> -<h2 id="new-widgets">New Widgets</h2> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="new-widgets">New Widgets<a href="#new-widgets" class="hash-link" aria-label="Direct link to New Widgets" title="Direct link to New Widgets">​</a></h2> <p>When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide.</p> -<h1 id="screen-keywords">Screen Keywords</h1> -<h2 id="screen">SCREEN</h2> +<h1>Screen Keywords</h1> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="screen">SCREEN<a href="#screen" class="hash-link" aria-label="Direct link to SCREEN" title="Direct link to SCREEN">​</a></h2> <p><strong>Define a telemetry viewer screen</strong></p> <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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen</td><td>True</td></tr><tr><td>Polling Period</td><td>Number of seconds between screen updates</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">SCREEN AUTO AUTO 1.0 FIXED -</code></pre> -<h2 id="end">END</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Indicates the close of a layout widget</strong></p> <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> -<h2 id="stale_time">STALE_TIME</h2> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="stale_time">STALE_TIME<a href="#stale_time" class="hash-link" aria-label="Direct link to STALE_TIME" title="Direct link to STALE_TIME">​</a></h2> <p></p><div class="right">(Since 5.1.0)</div><strong>Values are marked stale if the packet time is more than Stale Time seconds in the past</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>value</td><td>Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale. The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions.</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">STALE_TIME 5 # Number of seconds to wait before marking data stale -</code></pre> -<h2 id="global_setting">GLOBAL_SETTING</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Applies a widget setting to all widgets of a certain type</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Class Name</td><td>The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON.</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK -</code></pre> -<h2 id="global_subsetting">GLOBAL_SUBSETTING</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Applies a widget subsetting to all widgets of a certain type</strong></p> -<p>Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass &#x27;0:0&#x27; as the Subwidget Index to first index the LABELVALUE and then the LABEL.</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Class Name</td><td>The name of the class of widgets that this setting will be applied to. For example, LABELVALUE.</td><td>True</td></tr><tr><td>Subwidget Index</td><td>Index to the desired subwidget</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby"># Set all text color to white for labelvaluelimitsbars -GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white -</code></pre> -<h2 id="setting">SETTING</h2> +<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 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Applies a widget setting to the previously defined widget</strong></p> <p>Settings allow for additional tweaks and options to be applied to widgets that are not available in their parameters. These settings are all configured through the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords. SETTING and SUBSETTING applies only to the widget defined immediately before it. GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.</p> <p>Common wiget settings are defined here. Some widgets define their own unqiue settings which are documented under that specific widget.</p> -<h3 id="width">WIDTH</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="width">WIDTH<a href="#width" class="hash-link" aria-label="Direct link to WIDTH" title="Direct link to WIDTH">​</a></h3> <p><strong>Sets the widget width</strong></p> -<p>WIDTH supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING WIDTH 50 -LABEL &quot;THIS IS A TEST&quot; - SETTING WIDTH 20em -</code></pre> -<h3 id="height">HEIGHT</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Sets the widget height</strong></p> -<p>HEIGHT supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Height</td><td>Height in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR BLUE - SETTING HEIGHT 50 -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR GREY - SETTING HEIGHT 2em -</code></pre> -<h3 id="margin">MARGIN</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Sets the widget margin</strong></p> -<p>MARGIN supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Size in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR BLUE -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR GREY - SETTING MARGIN 10 -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR GREEN -</code></pre> -<h3 id="padding">PADDING</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Sets the widget padding</strong></p> -<p>PADDING supports <a href="https://www.w3schools.com/cssref/css_units.php">css units</a> with the default (no units) of px (pixels)</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Size in pixels or explicitly declared with units</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR BLUE -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR GREY - SETTING PADDING 10 -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR GREEN -</code></pre> -<h3 id="backcolor">BACKCOLOR</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>The BACKCOLOR setting sets the background color for a widget</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. &#x27;black&#x27;, &#x27;red&#x27;, etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR red -LABEL &quot;THIS IS A TEST&quot; - SETTING BACKCOLOR 155 50 155 -</code></pre> -<h3 id="textcolor">TEXTCOLOR</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>The TEXTCOLOR setting sets the text color for a widget</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. &#x27;black&#x27;, &#x27;red&#x27;, etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;THIS IS A TEST&quot; - SETTING TEXTCOLOR red -LABEL &quot;THIS IS A TEST&quot; - SETTING TEXTCOLOR 155 50 155 -</code></pre> -<h3 id="bordercolor">BORDERCOLOR</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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)">&quot;THIS IS A TEST&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>The BORDERCOLOR setting sets the border color for a layout widget</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Color name or Red value</td><td>Common name for the color, e.g. &#x27;black&#x27;, &#x27;red&#x27;, etc. Alternatively if two more parameters are passed this is the Red value of the RGB value</td><td>True</td></tr><tr><td>Green value</td><td>Green value of the RGB value</td><td>False</td></tr><tr><td>Blue value</td><td>Blue value of the RGB value</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">HORIZONTAL - LABEL &quot;Label 1&quot; -END -SETTING BORDERCOLOR red -VERTICAL - LABEL &quot;Label 2&quot; -END -SETTING BORDERCOLOR 155 50 155 -</code></pre> -<h3 id="raw">RAW</h3> +<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)">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)">&quot;Label 1&quot;</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)">&quot;Label 2&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Apply a raw CSS stylesheet key and value</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>CSS key like font-size, max-width, etc</td><td>True</td></tr><tr><td>Value</td><td>CSS Value</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;Label 1&quot; - SETTING RAW font-size 30px -</code></pre> -<h2 id="subsetting">SUBSETTING</h2> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Label 1&quot;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Applies a widget subsetting to the previously defined widget</strong></p> -<p>Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass &#x27;0:0&#x27; as the Subwidget Index to first index the LABELVALUE and then the LABEL.</p> +<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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Subwidget Index</td><td>Index to the desired subwidget or &#x27;ALL&#x27; to apply the setting to all the subwidgets of this composite widget.</td><td>True</td></tr><tr><td>Setting Name</td><td>See SETTING for details.</td><td>True</td></tr><tr><td>Setting Value(s)</td><td>See SETTING for details.</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VERTICALBOX - LABELVALUE INST HEALTH_STATUS TEMP1 - SUBSETTING 0 TEXTCOLOR blue # Change the label&#x27;s text to blue - LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1 - SUBSETTING 0:0 TEXTCOLOR green # Change the label&#x27;s text to green -END -</code></pre> -<h2 id="named_widget">NAMED_WIDGET</h2> +<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)">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&#x27;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&#x27;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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Name a widget to allow access to it via the getNamedWidget method</strong></p> <p>To programatically access parts of a telemetry screen you need to name the widget. This is useful when creating screens with buttons that read values from other widgets.</p> -<admonition type="warning"><p>getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget</p></admonition> +<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"></path></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</p></div></div> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Name</td><td>The unique name applied to the following widget instance. Names must be unique per screen.</td><td>True</td></tr><tr><td>Widget Type</td><td>One of the widget types listed in Widget Descriptions</td><td>True</td></tr><tr><td>Widget Parameters</td><td>The unique parameters for the given widget type</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">NAMED_WIDGET DURATION TEXTFIELD -BUTTON &quot;Push&quot; &quot;screen.getNamedWidget(&#x27;DURATION&#x27;).text()&quot; -</code></pre> -<h2 id="layout-widgets">Layout Widgets</h2> +<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)">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)">&quot;Push&quot;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;screen.getNamedWidget(&#x27;DURATION&#x27;).text()&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <hr> <p>Layout widgets are used to position other widgets on the screen. For example, the HORIZONTAL layout widget places the widgets it encapsulates horizontally on the screen.</p> -<h3 id="vertical">VERTICAL</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="vertical">VERTICAL<a href="#vertical" class="hash-link" aria-label="Direct link to VERTICAL" title="Direct link to VERTICAL">​</a></h3> <p><strong>Places the widgets it encapsulates vertically</strong></p> <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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VERTICAL 5px - LABEL &quot;TEST&quot; - LABEL &quot;SCREEN&quot; -END -</code></pre> -<h3 id="verticalbox">VERTICALBOX</h3> +<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)">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)">&quot;TEST&quot;</span><span class="token plain"></span><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)">&quot;SCREEN&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places the widgets it encapsulates vertically inside a thin border</strong></p> <p>The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Title</td><td>Text to place within the border to label the box</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VERTICALBOX Info - LABEL &quot;TEST&quot; - LABEL &quot;SCREEN&quot; -END -</code></pre> -<h3 id="horizontal">HORIZONTAL</h3> +<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)">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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;TEST&quot;</span><span class="token plain"></span><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)">&quot;SCREEN&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places the widgets it encapsulates horizontally</strong></p> <p>The HORIZONTAL widget sizes itself to fit its contents</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">HORIZONTAL 100 - LABEL &quot;TEST&quot; - LABEL &quot;SCREEN&quot; -END -</code></pre> -<h3 id="horizontalbox">HORIZONTALBOX</h3> +<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)">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)">&quot;TEST&quot;</span><span class="token plain"></span><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)">&quot;SCREEN&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places the widgets it encapsulates horizontally inside a thin border</strong></p> <p>The HORIZONTALBOX widget sizes itself to fit its contents</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Title</td><td>Text to place within the border to label the box</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">HORIZONTALBOX Info 10 - LABEL &quot;TEST&quot; - LABEL &quot;SCREEN&quot; -END -</code></pre> -<h3 id="matrixbycolumns">MATRIXBYCOLUMNS</h3> +<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)">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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;TEST&quot;</span><span class="token plain"></span><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)">&quot;SCREEN&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places the widgets into a table-like matrix</strong></p> <p>The MATRIXBYCOLUMNS widget sizes itself to fit its contents</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Columns</td><td>The number of columns to create</td><td>True</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">MATRIXBYCOLUMNS 3 10 - LABEL &quot;COL 1&quot; - LABEL &quot;COL 2&quot; - LABEL &quot;COL 3&quot; - LABEL &quot;100&quot; - LABEL &quot;200&quot; - LABEL &quot;300&quot; -END -</code></pre> -<h3 id="scrollwindow">SCROLLWINDOW</h3> +<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)">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)">&quot;COL 1&quot;</span><span class="token plain"></span><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)">&quot;COL 2&quot;</span><span class="token plain"></span><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)">&quot;COL 3&quot;</span><span class="token plain"></span><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)">&quot;100&quot;</span><span class="token plain"></span><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)">&quot;200&quot;</span><span class="token plain"></span><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)">&quot;300&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places the widgets inside of it into a scrollable area</strong></p> <p>The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Height</td><td>Maximum height of the scroll window in pixels (default = 200)</td><td>False</td></tr><tr><td>Margin</td><td>Margin between widgets (default = 0px)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">SCROLLWINDOW 100 10 - VERTICAL - LABEL &quot;100&quot; - LABEL &quot;200&quot; - LABEL &quot;300&quot; - LABEL &quot;400&quot; - LABEL &quot;500&quot; - LABEL &quot;600&quot; - LABEL &quot;700&quot; - LABEL &quot;800&quot; - LABEL &quot;900&quot; - END -END -</code></pre> -<h3 id="tabbook">TABBOOK</h3> +<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)">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)">&quot;100&quot;</span><span class="token plain"></span><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)">&quot;200&quot;</span><span class="token plain"></span><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)">&quot;300&quot;</span><span class="token plain"></span><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)">&quot;400&quot;</span><span class="token plain"></span><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)">&quot;500&quot;</span><span class="token plain"></span><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)">&quot;600&quot;</span><span class="token plain"></span><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)">&quot;700&quot;</span><span class="token plain"></span><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)">&quot;800&quot;</span><span class="token plain"></span><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)">&quot;900&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Creates a tabbed area in which to place TABITEM widgets</strong></p> -<h3 id="tabitem">TABITEM</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tabitem">TABITEM<a href="#tabitem" class="hash-link" aria-label="Direct link to TABITEM" title="Direct link to TABITEM">​</a></h3> <p><strong>Creates a VERTICAL layout tab into which to place widgets</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Tab text</td><td>Text to diplay in the tab</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">TABBOOK - TABITEM &quot;Tab 1&quot; - LABEL &quot;100&quot; - LABEL &quot;200&quot; - END - TABITEM &quot;Tab 2&quot; - LABEL &quot;300&quot; - LABEL &quot;400&quot; - END -END -</code></pre> -<h3 id="iframe">IFRAME</h3> +<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)">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)">&quot;Tab 1&quot;</span><span class="token plain"></span><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)">&quot;100&quot;</span><span class="token plain"></span><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)">&quot;200&quot;</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)">&quot;Tab 2&quot;</span><span class="token plain"></span><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)">&quot;300&quot;</span><span class="token plain"></span><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)">&quot;400&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Open external tools in an Iframe within OpenC3</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>URL</td><td>The path to the page to display in the iframe</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">IFRAME https://openc3.com 900 450 -</code></pre> -<h2 id="decoration-widgets">Decoration Widgets</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <hr> <p>Decoration widgets are used to enhance the appearance of the screen. They do not respond to input, nor does the output vary with telemetry.</p> -<h3 id="label">LABEL</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="label">LABEL<a href="#label" class="hash-link" aria-label="Direct link to LABEL" title="Direct link to LABEL">​</a></h3> <p><strong>Displays text on the screen</strong></p> <p>Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget.</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display on the label</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL &quot;Note: This is only a warning&quot; -</code></pre> -<h3 id="horizontalline">HORIZONTALLINE</h3> +<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)">LABEL</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Note: This is only a warning&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p></p><div class="right">(Since 5.5.1)</div><strong>Displays a horizontal line on the screen that can be used as a separator</strong><p></p> <p>Example Usage:</p> -<pre><code class="language-ruby">LABEL Over -HORIZONTALLINE -LABEL Under -</code></pre> -<h3 id="sectionheader">SECTIONHEADER</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="sectionheader">SECTIONHEADER<a href="#sectionheader" class="hash-link" aria-label="Direct link to SECTIONHEADER" title="Direct link to SECTIONHEADER">​</a></h3> <p><strong>DEPRECATED - Displays a label that is underlined with a horizontal line</strong></p> <p>Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display</td><td>True</td></tr></tbody></table> -<h3 id="title">TITLE</h3> +<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> <p><strong>Displays a large centered title on the screen</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">TITLE &quot;Title&quot; -HORIZONTALLINE -LABEL &quot;Label&quot; -</code></pre> -<h3 id="spacer">SPACER</h3> +<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)">TITLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Title&quot;</span><span class="token plain"></span><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)">&quot;Label&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Places a fixed size spacer in between widgets</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width of the spacer in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height of the spacer in pixels</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VERTICAL 3 - LABEL &quot;Spacer below&quot; - SPACER 0 100 - LABEL &quot;Spacer above&quot; -END -</code></pre> -<h2 id="telemetry-widgets">Telemetry Widgets</h2> +<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)">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)">&quot;Spacer below&quot;</span><span class="token plain"></span><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)">&quot;Spacer above&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <hr> <p>Telemetry widgets are used to display telemetry values. The first parameters to each of these widgets is a telemetry mnemonic. Depending on the type and purpose of the telemetry item, the screen designer may select from a wide selection of widgets to display the value in the most useful format.</p> -<h3 id="array">ARRAY</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="array">ARRAY<a href="#array" class="hash-link" aria-label="Direct link to ARRAY" title="Direct link to ARRAY">​</a></h3> <p><strong>Displays ARRAY data organized into rows and space separated</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget (default = 100)</td><td>False</td></tr><tr><td>Format string</td><td>Format string applied to each array item (default = nil)</td><td>False</td></tr><tr><td>Items per row</td><td>Number of array items per row (default = 4)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">ARRAY INST HEALTH_STATUS ARY 250 80 &quot;0x%x&quot; 6 FORMATTED -ARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS -</code></pre> -<h3 id="block">BLOCK</h3> +<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)">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)">&quot;0x%x&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="block">BLOCK<a href="#block" class="hash-link" aria-label="Direct link to BLOCK" title="Direct link to BLOCK">​</a></h3> <p><strong>Displays BLOCK data organized into rows and space separated</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget (default = 100)</td><td>False</td></tr><tr><td>Format string</td><td>Format string applied to each array item (default = nil)</td><td>False</td></tr><tr><td>Bytes per word</td><td>Number of bytes per word (default = 4)</td><td>False</td></tr><tr><td>Words per row</td><td>Number of words per row (default = 4</td><td>False</td></tr><tr><td>Address format</td><td>Format for the address printed at the beginning of each line (default = nil which means do not print an address)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">BLOCK INST IMAGE IMAGE 400 130 &quot;%02X&quot; 4 4 &quot;0x%08X:&quot; -</code></pre> -<h3 id="formatvalue">FORMATVALUE</h3> +<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)">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)">400</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">130</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;%02X&quot;</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)">&quot;0x%08X:&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a box with a formatted value</strong></p> <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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Format string</td><td>Printf style format string to apply to the telemetry item</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20 -</code></pre> -<h3 id="labelled">LABELLED</h3> +<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)">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><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LABEL followed by a LED</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Height</td><td>Height of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Justification</td><td>How to justify the label and LED together. The default of &#x27;SPLIT&#x27; aligns the label to the left and the LED to the right with any additional space going between them. &#x27;CENTER&#x27; pushes the label and LED together with any additional space to the left and right. &#x27;LEFT&#x27; or &#x27;RIGHT&#x27; pushes them to the respective side with the space going on the opposite.<br><br>Valid Values: <span class="values">SPLIT, CENTER, LEFT, RIGHT</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELLED INST PARAMS VALUE1 - SETTING LED_COLOR GOOD GREEN - SETTING LED_COLOR BAD RED -</code></pre> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to LABELLED. They are applied using the SETTING keyword.</p> -<h4 id="led_color">LED_COLOR</h4> +<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> <p><strong>Map a state or value to a color</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value. ANY used to match any value or state not declared.</td><td>True</td></tr><tr><td>LED color</td><td>Color of the LED</td><td>True</td></tr></tbody></table> -<h3 id="labelprogressbar">LABELPROGRESSBAR</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="labelprogressbar">LABELPROGRESSBAR<a href="#labelprogressbar" class="hash-link" aria-label="Direct link to LABELPROGRESSBAR" title="Direct link to LABELPROGRESSBAR">​</a></h3> <p><strong>Displays a LABEL with the item name followed by a PROGRESSBAR</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Scale factor</td><td>Value to multiply the telemetry item by before displaying in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.</td><td>False</td></tr><tr><td>Width</td><td>Width of the progress bar (default = 80 pixels</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW -LABELPROGRESSBAR INST ADCS POSPROGRESS -</code></pre> -<h3 id="labelvalue">LABELVALUE</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LABEL with the item name followed by a VALUE</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELVALUE INST LATEST TIMESEC CONVERTED 18 -LABELVALUE INST LATEST COLLECT_TYPE -</code></pre> -<h3 id="labelvaluedesc">LABELVALUEDESC</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LABEL with the items description followed by a VALUE</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Description</td><td>The description to display in the label (default is to display the description text associated with the telemetry item)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELVALUEDESC INST HEALTH_STATUS TEMP1 &quot;Temperature number 1&quot; RAW 18 -LABELVALUEDESC INST HEALTH_STATUS COLLECT_TYPE -</code></pre> -<h3 id="labelvaluelimitsbar">LABELVALUELIMITSBAR</h3> +<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)">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)">&quot;Temperature number 1&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> -<h3 id="labelvaluelimitscolumn">LABELVALUELIMITSCOLUMN</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="labelvaluelimitscolumn">LABELVALUELIMITSCOLUMN<a href="#labelvaluelimitscolumn" class="hash-link" aria-label="Direct link to LABELVALUELIMITSCOLUMN" title="Direct link to LABELVALUELIMITSCOLUMN">​</a></h3> <p><strong>Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18 -LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="labelvaluerangebar">LABELVALUERANGEBAR</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40 -LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120 -</code></pre> -<h3 id="led">LED</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a LED which changes color based on telemetry values</strong></p> <p>By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the LED circle (default = 15)</td><td>False</td></tr><tr><td>Height</td><td>Height of the LED circle (default = 15)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LED INST PARAMS VALUE5 RAW 25 20 # Ellipse - SETTING LED_COLOR 0 GREEN - SETTING LED_COLOR 1 RED - SETTING LED_COLOR ANY YELLOW -</code></pre> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to LED. They are applied using the SETTING keyword.</p> -<h4 id="led_color-1">LED_COLOR</h4> +<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> <p><strong>Map a state or value to a color</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value. ANY used to match any value or state not declared.</td><td>True</td></tr><tr><td>LED color</td><td>Color of the LED</td><td>True</td></tr></tbody></table> -<h3 id="limitsbar">LIMITSBAR</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="limitsbar">LIMITSBAR<a href="#limitsbar" class="hash-link" aria-label="Direct link to LIMITSBAR" title="Direct link to LIMITSBAR">​</a></h3> <p><strong>Displays an item&#x27;s current value within its colored limits horizontally</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50 -LIMITSBAR INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="limitscolumn">LIMITSCOLUMN</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays an item&#x27;s current value within its colored limits vertically</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200 -LIMITSCOLUMN INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="limitscolor">LIMITSCOLOR</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a circle depicting the limits color of an item</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Radius</td><td>Radius of the circle (default is 10)</td><td>False</td></tr><tr><td>Full Item Name</td><td>Show the full item name (default is false)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE -LIMITSCOLOR INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="valuelimitsbar">VALUELIMITSBAR</h3> +<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)">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)">30</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">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)">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><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays an item VALUE followed by LIMITSBAR</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18 -VALUELIMITSBAR INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="valuelimitscolumn">VALUELIMITSCOLUMN</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays an item VALUE followed by LIMITSCOLUMN</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 8)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18 -VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 -</code></pre> -<h3 id="valuerangebar">VALUERANGEBAR</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays an item VALUE followed by RANGEBAR</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 160)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40 -VALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120 -</code></pre> -<h3 id="linegraph">LINEGRAPH</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a line graph of a telemetry item</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LINEGRAPH INST HEALTH_STATUS TEMP1 - SETTING ITEM INST ADCS Q1 # Add additional item to graph -LINEGRAPH INST HEALTH_STATUS TEMP2 RAW -LINEGRAPH INST HEALTH_STATUS TEMP3 CONVERTED REDUCED_MINUTE MIN - SETTING SIZE 600 500 # width height - SETTING HISTORY 1h # load 1 hour of data into graph -LINEGRAPH INST HEALTH_STATUS TEMP4 - SETTING HISTORY 30m # load 30 minutes of data into graph -</code></pre> +<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)">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><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><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)">TEMP2</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)">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)">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 constant" style="color:rgb(130, 170, 255)">REDUCED_MINUTE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"></span><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)">500</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># width height</span><span class="token plain"></span><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)">1</span><span class="token plain">h </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># load 1 hour of data into graph</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><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)">TEMP4</span><span class="token plain"></span><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">m </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># load 30 minutes of data into graph</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to LINEGRAPH. They are applied using the SETTING keyword.</p> -<h4 id="item">ITEM</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="item">ITEM<a href="#item" class="hash-link" aria-label="Direct link to ITEM" title="Direct link to ITEM">​</a></h4> <p><strong>Add a telemetry item to the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> -<h4 id="starttime">STARTTIME</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="starttime">STARTTIME<a href="#starttime" class="hash-link" aria-label="Direct link to STARTTIME" title="Direct link to STARTTIME">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted &#x27;YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->&#x27;</td><td>True</td></tr></tbody></table> -<h4 id="history">HISTORY</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="history">HISTORY<a href="#history" class="hash-link" aria-label="Direct link to HISTORY" title="Direct link to HISTORY">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table> -<h4 id="secondsgraphed">SECONDSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="secondsgraphed">SECONDSGRAPHED<a href="#secondsgraphed" class="hash-link" aria-label="Direct link to SECONDSGRAPHED" title="Direct link to SECONDSGRAPHED">​</a></h4> <p><strong>Display the specified number of seconds in the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table> -<h4 id="pointssaved">POINTSSAVED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointssaved">POINTSSAVED<a href="#pointssaved" class="hash-link" aria-label="Direct link to POINTSSAVED" title="Direct link to POINTSSAVED">​</a></h4> <p><strong>Save the number of seconds in graph memory</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table> -<h4 id="pointsgraphed">POINTSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointsgraphed">POINTSGRAPHED<a href="#pointsgraphed" class="hash-link" aria-label="Direct link to POINTSGRAPHED" title="Direct link to POINTSGRAPHED">​</a></h4> <p><strong>Number of points to display on the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table> -<h4 id="size">SIZE</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="size">SIZE<a href="#size" class="hash-link" aria-label="Direct link to SIZE" title="Direct link to SIZE">​</a></h4> <p><strong>Size of the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table> -<h3 id="sparkline">SPARKLINE</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="sparkline">SPARKLINE<a href="#sparkline" class="hash-link" aria-label="Direct link to SPARKLINE" title="Direct link to SPARKLINE">​</a></h3> <p><strong>Displays a sparkline graph (no cursor, scale or legend) of a telemetry item</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">SPARKLINE INST HEALTH_STATUS TEMP1 - SETTING SIZE 400 50 - SETTING HISTORY 30s # Add 30 seconds of data into graph -</code></pre> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to SPARKLINE. They are applied using the SETTING keyword.</p> -<h4 id="item-1">ITEM</h4> +<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> <p><strong>Add a telemetry item to the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> -<h4 id="starttime-1">STARTTIME</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="starttime-1">STARTTIME<a href="#starttime-1" class="hash-link" aria-label="Direct link to STARTTIME" title="Direct link to STARTTIME">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted &#x27;YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->&#x27;</td><td>True</td></tr></tbody></table> -<h4 id="history-1">HISTORY</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="history-1">HISTORY<a href="#history-1" class="hash-link" aria-label="Direct link to HISTORY" title="Direct link to HISTORY">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table> -<h4 id="secondsgraphed-1">SECONDSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="secondsgraphed-1">SECONDSGRAPHED<a href="#secondsgraphed-1" class="hash-link" aria-label="Direct link to SECONDSGRAPHED" title="Direct link to SECONDSGRAPHED">​</a></h4> <p><strong>Display the specified number of seconds in the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table> -<h4 id="pointssaved-1">POINTSSAVED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointssaved-1">POINTSSAVED<a href="#pointssaved-1" class="hash-link" aria-label="Direct link to POINTSSAVED" title="Direct link to POINTSSAVED">​</a></h4> <p><strong>Save the number of seconds in graph memory</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table> -<h4 id="pointsgraphed-1">POINTSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointsgraphed-1">POINTSGRAPHED<a href="#pointsgraphed-1" class="hash-link" aria-label="Direct link to POINTSGRAPHED" title="Direct link to POINTSGRAPHED">​</a></h4> <p><strong>Number of points to display on the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table> -<h4 id="size-1">SIZE</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="size-1">SIZE<a href="#size-1" class="hash-link" aria-label="Direct link to SIZE" title="Direct link to SIZE">​</a></h4> <p><strong>Size of the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table> -<h3 id="labelsparkline">LABELSPARKLINE</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="labelsparkline">LABELSPARKLINE<a href="#labelsparkline" class="hash-link" aria-label="Direct link to LABELSPARKLINE" title="Direct link to LABELSPARKLINE">​</a></h3> <p><strong>Displays a LABEL with the item name followed by a SPARKLINE</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">LABELSPARKLINE INST HEALTH_STATUS TEMP1 - SETTING HISTORY 5m # Add 5 minutes of data into graph -</code></pre> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword.</p> -<h4 id="item-2">ITEM</h4> +<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> <p><strong>Add a telemetry item to the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr><tr><td>Reduced</td><td>Whether to display reduced data. Default is DECOM.<br><br>Valid Values: <span class="values">DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY</span></td><td>False</td></tr><tr><td>Reduced Type</td><td>The type of reduce data to display. Only applies if Reduced is not DECOM.<br><br>Valid Values: <span class="values">MIN, MAX, AVG, STDDEV</span></td><td>False</td></tr></tbody></table> -<h4 id="starttime-2">STARTTIME</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="starttime-2">STARTTIME<a href="#starttime-2" class="hash-link" aria-label="Direct link to STARTTIME" title="Direct link to STARTTIME">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Start the graph history at the designated Time</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start Time</td><td>Start time as formatted &#x27;YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->&#x27;</td><td>True</td></tr></tbody></table> -<h4 id="history-2">HISTORY</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="history-2">HISTORY<a href="#history-2" class="hash-link" aria-label="Direct link to HISTORY" title="Direct link to HISTORY">​</a></h4> <p></p><div class="right">(Since 5.5.1)</div><strong>Display an initial history of data</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>Value(d,h,m,s). For example 1d, 2h, 30m, 15s</td><td>True</td></tr></tbody></table> -<h4 id="secondsgraphed-2">SECONDSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="secondsgraphed-2">SECONDSGRAPHED<a href="#secondsgraphed-2" class="hash-link" aria-label="Direct link to SECONDSGRAPHED" title="Direct link to SECONDSGRAPHED">​</a></h4> <p><strong>Display the specified number of seconds in the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to display</td><td>True</td></tr></tbody></table> -<h4 id="pointssaved-2">POINTSSAVED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointssaved-2">POINTSSAVED<a href="#pointssaved-2" class="hash-link" aria-label="Direct link to POINTSSAVED" title="Direct link to POINTSSAVED">​</a></h4> <p><strong>Save the number of seconds in graph memory</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to save</td><td>True</td></tr></tbody></table> -<h4 id="pointsgraphed-2">POINTSGRAPHED</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="pointsgraphed-2">POINTSGRAPHED<a href="#pointsgraphed-2" class="hash-link" aria-label="Direct link to POINTSGRAPHED" title="Direct link to POINTSGRAPHED">​</a></h4> <p><strong>Number of points to display on the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of points to graph</td><td>True</td></tr></tbody></table> -<h4 id="size-2">SIZE</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="size-2">SIZE<a href="#size-2" class="hash-link" aria-label="Direct link to SIZE" title="Direct link to SIZE">​</a></h4> <p><strong>Size of the graph</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width in pixels</td><td>True</td></tr><tr><td>Height</td><td>Height in pixels</td><td>True</td></tr></tbody></table> -<h3 id="imageviewer">IMAGEVIEWER</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="imageviewer">IMAGEVIEWER<a href="#imageviewer" class="hash-link" aria-label="Direct link to IMAGEVIEWER" title="Direct link to IMAGEVIEWER">​</a></h3> <p><strong>Display a base64 image from a TLM packet</strong></p> -<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Format</td><td>The image format of the base64 data (e.g. jpg, png, etc)</td><td>True</td></tr><tr><td>Width</td><td>Width of the widget</td><td>False</td></tr><tr><td>Height</td><td>Height of the widget</td><td>False</td></tr></tbody></table> +<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name to pull the CONVERTED value from. If additional processing (base64 encoding) is needed consider using a DERIVED item.</td><td>True</td></tr><tr><td>Format</td><td>The image format of the base64 data (e.g. jpg, png, etc)</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">IMAGEVIEWER INST IMAGE IMAGE jpg -</code></pre> -<h3 id="progressbar">PROGRESSBAR</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a progress bar that is useful for displaying percentages</strong></p> <p>Example Usage:</p> -<pre><code class="language-ruby">PROGRESSBAR INST ADCS POSPROGRESS 0.5 200 -PROGRESSBAR INST ADCS POSPROGRESS -</code></pre> -<h3 id="rangebar">RANGEBAR</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a custom range bar displaying the item value</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Low Value</td><td>Minimum value to display on the range bar. If the telemetry item goes below this value the bar is “pegged” on the low end.</td><td>True</td></tr><tr><td>High Value</td><td>Maximum value to display on the range bar. If the telemetry item goes above this value the bar is “pegged” on the high end.</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Width</td><td>Width of the range bar (default = 100)</td><td>False</td></tr><tr><td>Height</td><td>Height of the range bar (default = 25)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">RANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50 -RANGEBAR INST HEALTH_STATUS TEMP1 -100 100 -</code></pre> -<h3 id="rollup">ROLLUP</h3> -<p><strong>Displays a notification icon which changes color based on a rollup telemetry</strong></p> -<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon name</td><td>The astro UX icon to display. Valid choices are &#x27;astro&#x27; icons taken from</td><td></td></tr><tr><td><a href="https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json">https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json</a></td><td></td><td></td></tr><tr><td>True</td><td></td><td></td></tr><tr><td>Icon label</td><td>Text to apply to the icon label</td><td>False</td></tr><tr><td>Icon sublabel</td><td>Text to apply to the icon sublabel</td><td>False</td></tr></tbody></table> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> +<p></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> +<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon name</td><td>The astro UX icon to display. Valid choices are &#x27;astro&#x27; 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><td>True</td></tr><tr><td>Icon label</td><td>Text to apply to the icon label</td><td>False</td></tr><tr><td>Icon sublabel</td><td>Text to apply to the icon sublabel</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">ROLLUP satellite-transmit &quot;SAT 1&quot; &quot;Details&quot; - SETTING SCREEN INST HS - SETTING TLM INST HEALTH_STATUS TEMP1 - SETTING TLM INST HEALTH_STATUS TEMP2 -ROLLUP antenna &quot;GND 2&quot; &quot;Location&quot; - SETTING SCREEN INST HS - SETTING TLM INST HEALTH_STATUS TEMP3 - SETTING TLM INST HEALTH_STATUS TEMP4 -</code></pre> -<h3 id="textbox">TEXTBOX</h3> +<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)">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)">&quot;SAT 1&quot;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Details&quot;</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)">&quot;GND 2&quot;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Location&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> +<p></p><div class="right">(Since 5.17.2)</div><strong>Displays a cellular signal icon which changes based on telemetry value</strong><p></p> +<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED</span></td><td>False</td></tr></tbody></table> +<p>Example Usage:</p> +<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)">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 &lt; -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 &gt;= -50 and &lt; 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 &gt;= 0 and &lt; 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 &gt;= 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Provides a large box for multiline text</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Width</td><td>Width of the textbox in px (default = 200)</td><td>False</td></tr><tr><td>Height</td><td>Height of the textbox in px (default = 200)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70 -TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED -</code></pre> -<h3 id="value">VALUE</h3> +<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)">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><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><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><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a box with a telemetry item value</strong></p> <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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr><tr><td>Number of characters</td><td>The number of characters wide to make the value box (default = 12)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18 -VALUE INST HEALTH_STATUS TEMP1 -</code></pre> -<h2 id="interactive-widgets">Interactive Widgets</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <hr> <p>Interactive widgets are used to gather input from the user. Unlike all other widgets, which only output some graphical representation, interactive widgets permit input either from the keyboard or mouse.</p> -<h3 id="button">BUTTON</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="button">BUTTON<a href="#button" class="hash-link" aria-label="Direct link to BUTTON" title="Direct link to BUTTON">​</a></h3> <p><strong>Displays a rectangular clickable button</strong></p> -<p>Upon clicking, the button executes the Ruby code assigned. Buttons +<p>Upon clicking, the button executes the Javascript code assigned. Buttons can be used to send commands and perform other tasks. If you want your button to use values from other widgets, define them as named widgets and read their values using the <code>screen.getNamedWidget(&quot;WIDGET_NAME&quot;).text()</code> method. See the example in CHECKBUTTON.</p> <p>Button code can get rather complex so remember to use string concatenation @@ -586,196 +413,108 @@ during string concatenation. If you use <code>\</code> you&#x27;ll need to separate lines with a single semicolon <code>;</code>. COSMOS uses double semicolon <code>;;</code> to indicate lines should be evaluated separately. Note that all OpenC3 commands (using api.cmd) must be separated by <code>;;</code>.</p> <p>You can send commands with buttons using api.cmd(). The cmd() syntax looks exactly -like the standard COSMOS Ruby scripting syntax. You can also request and use +like the standard COSMOS scripting syntax. You can also request and use telemetry in screens using Javascript Promises.</p> <p><code>api.tlm(&#x27;INST PARAMS VALUE3&#x27;, &#x27;RAW&#x27;).then(dur =&gt; api.cmd(&#x27;INST COLLECT with TYPE NORMAL, DURATION &#x27;+dur))&quot;</code></p> <p>The api.tlm() function returns a Promise which is resolved with then() at which point we send the command with the telemetry value we received.</p> <p>Scripts can be launched from a BUTTON using the <code>runScript()</code> method. <code>runScript()</code> takes three parameters, the name of the script, whether to open the script in the foreground of Script Runner (default = true), and a hash of environment variables. For example: <code>runScript(&#x27;INST/procedures/script.rb&#x27;, false, {&#x27;VAR&#x27;: &#x27;VALUE&#x27;})</code></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Button Text</td><td>Text displayed on the button</td><td>True</td></tr><tr><td>Button Code</td><td>Javascript code to execute when the button is pressed</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">BUTTON &#x27;Start Collect&#x27; &#x27;api.cmd(&quot;INST COLLECT with TYPE NORMAL, DURATION 5&quot;)&#x27; -BUTTON &#x27;Run Checks&#x27; &#x27;runScript(&quot;INST/procedures/checks.rb&quot;)&#x27; -# More complex example with background checkbox and env vars -NAMED_WIDGET SCRIPTNAME COMBOBOX collect.rb checks.rb -NAMED_WIDGET BG CHECKBUTTON &#x27;Background&#x27; -BUTTON &#x27;Run Script&#x27; &quot;var script=screen.getNamedWidget(&#x27;SCRIPTNAME&#x27;).text();&quot; \ - # Set an environment variable to be used by the script as ENV[&#x27;TYPE&#x27;] - &quot;var env = {}; env[&#x27;TYPE&#x27;] = &#x27;TEST&#x27;;&quot; \ - &quot;runScript(&#x27;INST/procedures/&#x27;+script, !screen.getNamedWidget(&#x27;BG&#x27;).checked(), env)&quot; -</code></pre> -<h3 id="checkbutton">CHECKBUTTON</h3> +<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)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;Start Collect&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;api.cmd(&quot;INST COLLECT with TYPE NORMAL, DURATION 5&quot;)&#x27;</span><span class="token plain"></span><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)">&#x27;Run Checks&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;runScript(&quot;INST/procedures/checks.rb&quot;)&#x27;</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)">&#x27;Background&#x27;</span><span class="token plain"></span><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)">&#x27;Run Script&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;var script=screen.getNamedWidget(&#x27;SCRIPTNAME&#x27;).text();&quot;</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[&#x27;TYPE&#x27;]</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)">&quot;var env = {}; env[&#x27;TYPE&#x27;] = &#x27;TEST&#x27;;&quot;</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)">&quot;runScript(&#x27;INST/procedures/&#x27;+script, !screen.getNamedWidget(&#x27;BG&#x27;).checked(), env)&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a check box</strong></p> <p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Checkbox Text</td><td>Text displayed next to the checkbox</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">NAMED_WIDGET CHECK CHECKBUTTON &#x27;Ignore Hazardous Checks&#x27; -BUTTON &#x27;Send&#x27; &#x27;screen.getNamedWidget(&quot;CHECK&quot;).checked() ? &#x27; \ - &#x27;api.cmd_no_hazardous_check(&quot;INST CLEAR&quot;) : api.cmd(&quot;INST CLEAR&quot;)&#x27; -</code></pre> -<h3 id="combobox">COMBOBOX</h3> +<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)">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)">&#x27;Ignore Hazardous Checks&#x27;</span><span class="token plain"></span><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)">&#x27;Send&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;screen.getNamedWidget(&quot;CHECK&quot;).checked() ? &#x27;</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)">&#x27;api.cmd_no_hazardous_check(&quot;INST CLEAR&quot;) : api.cmd(&quot;INST CLEAR&quot;)&#x27;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a drop down list of text items</strong></p> <p>Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET.</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Option Text 1</td><td>Text to display in the selection drop down</td><td>True</td></tr><tr><td>Option Text n</td><td>Text to display in the selection drop down</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">BUTTON &#x27;Start Collect&#x27; &#x27;var type = screen.getNamedWidget(&quot;COLLECT_TYPE&quot;).text();&#x27; + - &#x27;api.cmd(&quot;INST COLLECT with TYPE &quot;+type+&quot;, DURATION 10.0&quot;)&#x27; -NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL -</code></pre> -<h3 id="radiogroup">RADIOGROUP</h3> +<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)">BUTTON</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;Start Collect&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;var type = screen.getNamedWidget(&quot;COLLECT_TYPE&quot;).text();&#x27;</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)">&#x27;api.cmd(&quot;INST COLLECT with TYPE &quot;+type+&quot;, DURATION 10.0&quot;)&#x27;</span><span class="token plain"></span><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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Creates a group of RADIOBUTTONs</strong></p> <p>RADIOBUTTONs must be part of a group to enable selection logic</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Initial selected button</td><td>Selects a radio button at initialization (0-based)</td><td>False</td></tr></tbody></table> -<h3 id="radiobutton">RADIOBUTTON</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="radiobutton">RADIOBUTTON<a href="#radiobutton" class="hash-link" aria-label="Direct link to RADIOBUTTON" title="Direct link to RADIOBUTTON">​</a></h3> <p><strong>Displays a radio button and text</strong></p> <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> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Text</td><td>Text to display next to the radio button</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">NAMED_WIDGET GROUP RADIOGROUP 1 # Select &#x27;Clear&#x27; initially, 0-based index - RADIOBUTTON &#x27;Abort&#x27; - RADIOBUTTON &#x27;Clear&#x27; -END -BUTTON &#x27;Send&#x27; &quot;screen.getNamedWidget(&#x27;GROUP&#x27;).selected() === 0 ? &quot; + - &quot;api.cmd(&#x27;INST ABORT&#x27;) : api.cmd(&#x27;INST CLEAR&#x27;)&quot; -</code></pre> -<h3 id="textfield">TEXTFIELD</h3> +<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)">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 &#x27;Clear&#x27; 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)">&#x27;Abort&#x27;</span><span class="token plain"></span><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)">&#x27;Clear&#x27;</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)">&#x27;Send&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;screen.getNamedWidget(&#x27;GROUP&#x27;).selected() === 0 ? &quot;</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)">&quot;api.cmd(&#x27;INST ABORT&#x27;) : api.cmd(&#x27;INST CLEAR&#x27;)&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays a rectangular box where the user can enter text</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Characters</td><td>Width of the text field in characters (default = 12)</td><td>False</td></tr><tr><td>Text</td><td>Default text to put in the text field (default is blank)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">NAMED_WIDGET DURATION TEXTFIELD 12 &quot;10.0&quot; -BUTTON &#x27;Start Collect&#x27; &#x27;var dur = screen.getNamedWidget(&quot;DURATION&quot;).text();&#x27; + - &#x27;api.cmd(&quot;INST COLLECT with TYPE NORMAL, DURATION &quot;+dur+&quot;&quot;)&#x27; -</code></pre> -<h2 id="canvas-widgets">Canvas Widgets</h2> +<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)">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)">&quot;10.0&quot;</span><span class="token plain"></span><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)">&#x27;Start Collect&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;var dur = screen.getNamedWidget(&quot;DURATION&quot;).text();&#x27;</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)">&#x27;api.cmd(&quot;INST COLLECT with TYPE NORMAL, DURATION &quot;+dur+&quot;&quot;)&#x27;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <hr> <p>Canvas Widgets are used to draw custom displays into telemetry screens. The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.</p> -<h3 id="canvas">CANVAS</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="canvas">CANVAS<a href="#canvas" class="hash-link" aria-label="Direct link to CANVAS" title="Direct link to CANVAS">​</a></h3> <p><strong>Layout widget for the other canvas widgets</strong></p> <p>All canvas widgets must be enclosed within a CANVAS widget.</p> -<admonition type="warning"><p>The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.</p></admonition> +<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"></path></svg></span>warning</div><div class="admonitionContent_bl22"><p>The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.</p></div></div> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Width</td><td>Width of the canvas</td><td>True</td></tr><tr><td>Height</td><td>Height of the canvas</td><td>True</td></tr></tbody></table> -<h3 id="canvaslabel">CANVASLABEL</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="canvaslabel">CANVASLABEL<a href="#canvaslabel" class="hash-link" aria-label="Direct link to CANVASLABEL" title="Direct link to CANVASLABEL">​</a></h3> <p><strong>Draws text onto the canvas</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>X Position</td><td>X position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Text</td><td>Text to draw onto the canvas</td><td>True</td></tr><tr><td>Font Size</td><td>Font size of the text (Default = 12)</td><td>False</td></tr><tr><td>Color</td><td>Color of the text</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 100 100 - CANVASLABEL 5 34 &quot;Label1&quot; 24 red - CANVASLABEL 5 70 &quot;Label2&quot; 18 blue -END -</code></pre> -<h3 id="canvaslabelvalue">CANVASLABELVALUE</h3> +<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)">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)">&quot;Label1&quot;</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)">&quot;Label2&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Draws the text value of a telemetry item onto the canvas in an optional frame</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the text on the canvas</td><td>True</td></tr><tr><td>Font Size</td><td>Font size of the text (Default = 12)</td><td>False</td></tr><tr><td>Color</td><td>Color of the text</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED.<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 200 100 - CANVASLABELVALUE INST HEALTH_STATUS TEMP1 5 34 12 red - CANVASLABELVALUE INST HEALTH_STATUS TEMP2 5 70 10 blue WITH_UNITS -END -</code></pre> -<h3 id="canvasimage">CANVASIMAGE</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Displays an image on the canvas</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Image filename</td><td>Name of a image file. The file must be in the plugin&#x27;s targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 250 430 - CANVASIMAGE &quot;satellite.png&quot; 10 10 200 200 - SETTING SCREEN INST HS - CANVASIMAGE &quot;https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&amp;cs=tinysrgb&amp;dpr=2&amp;h=640&amp;w=426&quot; 0 250 250 150 -END -</code></pre> +<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)">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)">&quot;satellite.png&quot;</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)">&quot;https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&amp;cs=tinysrgb&amp;dpr=2&amp;h=640&amp;w=426&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword.</p> -<h4 id="screen-1">SCREEN</h4> +<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> <p><strong>Open another screen when clicked</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>Name of the target</td><td>True</td></tr><tr><td>Screen name</td><td>Name of the screen</td><td>True</td></tr></tbody></table> -<h3 id="canvasimagevalue">CANVASIMAGEVALUE</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="canvasimagevalue">CANVASIMAGEVALUE<a href="#canvasimagevalue" class="hash-link" aria-label="Direct link to CANVASIMAGEVALUE" title="Direct link to CANVASIMAGEVALUE">​</a></h3> <p><strong>Displays an image on the canvas that changes with a telemetry value</strong></p> <p>Use various SETTING values to indicate which images should be displayed based on telemetry. For example, SETTING IMAGE CONNECTED &quot;ground_on.png&quot; 400 100. See the DEMO for a complete example.</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Value type</td><td>The type of the value to display<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>True</td></tr><tr><td>Default image filename</td><td>The default image to display. The file must be in the targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Image width</td><td>Width of the image (default is 100%)</td><td>False</td></tr><tr><td>Image height</td><td>Height of the image (default is 100%)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 230 230 - CANVASIMAGEVALUE INST HEALTH_STATUS GROUND1STATUS CONVERTED &quot;ground_error.png&quot; 10 10 180 180 - SETTING IMAGE CONNECTED &quot;ground_on.png&quot; 10 10 - SETTING IMAGE UNAVAILABLE &quot;ground_off.png&quot; 10 10 - SETTING SCREEN INST HS -END -</code></pre> +<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)">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)">&quot;ground_error.png&quot;</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)">&quot;ground_on.png&quot;</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)">&quot;ground_off.png&quot;</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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword.</p> -<h4 id="image">IMAGE</h4> +<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> <p><strong>Map an image to a state or value</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value</td><td>True</td></tr><tr><td>Image filename</td><td>Image to display. The file must be in the targets/TARGET/public directory.</td><td>True</td></tr><tr><td>X Position</td><td>X position of the upper-left corner of the image on the canvas</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the upper-left corner of the image on the canvas</td><td>True</td></tr></tbody></table> -<h4 id="screen-2">SCREEN</h4> +<h4 class="anchor anchorWithStickyNavbar_fF9Z" id="screen-2">SCREEN<a href="#screen-2" class="hash-link" aria-label="Direct link to SCREEN" title="Direct link to SCREEN">​</a></h4> <p><strong>Open another screen when clicked</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>Name of the target</td><td>True</td></tr><tr><td>Screen name</td><td>Name of the screen</td><td>True</td></tr></tbody></table> -<h3 id="canvasline">CANVASLINE</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="canvasline">CANVASLINE<a href="#canvasline" class="hash-link" aria-label="Direct link to CANVASLINE" title="Direct link to CANVASLINE">​</a></h3> <p><strong>Draws a line onto the canvas</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Start X Position</td><td>X position of the start of the line on the canvas</td><td>True</td></tr><tr><td>Start Y Position</td><td>Y position of the start of the line on the canvas</td><td>True</td></tr><tr><td>End X Position</td><td>X position of the end of the line on the canvas</td><td>True</td></tr><tr><td>End Y Position</td><td>Y position of the end of the line on the canvas</td><td>True</td></tr><tr><td>Color</td><td>Color of the line</td><td>False</td></tr><tr><td>Width</td><td>Width of the line in pixels (default = 1)</td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 100 50 - CANVASLINE 5 5 95 5 - CANVASLINE 5 5 5 45 green 2 - CANVASLINE 95 5 95 45 blue 3 -END -</code></pre> -<h3 id="canvaslinevalue">CANVASLINEVALUE</h3> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p><strong>Draws a color changing line onto the canvas</strong></p> <p>The line is represented by one of two colors based on the value of the associated telemetry item</p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target name</td><td>The target name</td><td>True</td></tr><tr><td>Packet name</td><td>The packet name</td><td>True</td></tr><tr><td>Item name</td><td>The item name</td><td>True</td></tr><tr><td>Start X Position</td><td>X position of the start of the line on the canvas</td><td>True</td></tr><tr><td>Start Y Position</td><td>Y position of the start of the line on the canvas</td><td>True</td></tr><tr><td>End X Position</td><td>X position of the end of the line on the canvas</td><td>True</td></tr><tr><td>End Y Position</td><td>Y position of the end of the line on the canvas</td><td>True</td></tr><tr><td>Width</td><td>Width of the line in pixels (default = 3)</td><td>False</td></tr><tr><td>Value type</td><td>The type of the value to display. Default is CONVERTED<br><br>Valid Values: <span class="values">RAW, CONVERTED, FORMATTED, WITH_UNITS</span></td><td>False</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 120 50 - CANVASLABELVALUE INST HEALTH_STATUS GROUND1STATUS 0 12 12 black - CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 25 115 25 5 RAW - SETTING VALUE_EQ 1 GREEN - SETTING VALUE_EQ 0 RED - CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 45 115 45 - SETTING VALUE_EQ CONNECTED GREEN - SETTING VALUE_EQ UNAVAILABLE RED -END -</code></pre> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> <p>The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword.</p> -<h4 id="value_eq">VALUE_EQ</h4> +<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> <p></p><div class="right">(Since 5.5.1)</div><strong>Map a value to a color</strong><p></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Value</td><td>State or value</td><td>True</td></tr><tr><td>Color</td><td>Color of the line</td><td>True</td></tr></tbody></table> -<h3 id="canvasdot">CANVASDOT</h3> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="canvasdot">CANVASDOT<a href="#canvasdot" class="hash-link" aria-label="Direct link to CANVASDOT" title="Direct link to CANVASDOT">​</a></h3> <p><strong>Draws a dot onto the canvas</strong></p> <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>X Position</td><td>X position of the dot</td><td>True</td></tr><tr><td>Y Position</td><td>Y position of the dot</td><td>True</td></tr><tr><td>Color</td><td>Color of the dot</td><td>True</td></tr><tr><td>Radius</td><td>Radius of the dot in pixels</td><td>True</td></tr></tbody></table> <p>Example Usage:</p> -<pre><code class="language-ruby">CANVAS 50 50 - CANVASDOT 10 15 BLUE 5 -END -</code></pre> -<h2 id="example-file">Example File</h2> +<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)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> +<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> <p>Example File: TARGET/myscreen.txt</p> -<pre><code class="language-ruby">SCREEN AUTO AUTO 0.5 -VERTICAL - TITLE &quot;&lt;%= target_name %&gt; Commanding Examples&quot; - LABELVALUE INST HEALTH_STATUS COLLECTS - LABELVALUE INST HEALTH_STATUS COLLECT_TYPE - LABELVALUE INST HEALTH_STATUS DURATION - VERTICALBOX &quot;Send Collect Command:&quot; - HORIZONTAL - LABEL &quot;Type: &quot; - NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL - END - HORIZONTAL - LABEL &quot; Duration: &quot; - NAMED_WIDGET DURATION TEXTFIELD 12 &quot;10.0&quot; - END - BUTTON &#x27;Start Collect&#x27; &quot;api.cmd(&#x27;INST COLLECT with TYPE &#x27;+screen.getNamedWidget(&#x27;COLLECT_TYPE&#x27;).text()+&#x27;, DURATION &#x27;+screen.getNamedWidget(&#x27;DURATION&#x27;).text())&quot; - END - SETTING BACKCOLOR 163 185 163 - VERTICALBOX &quot;Parameter-less Commands:&quot; - NAMED_WIDGET GROUP RADIOGROUP 1 # Select &#x27;Clear&#x27; initially, 0-based index - RADIOBUTTON &#x27;Abort&#x27; - RADIOBUTTON &#x27;Clear&#x27; - END - NAMED_WIDGET CHECK CHECKBUTTON &#x27;Ignore Hazardous Checks&#x27; # No option is by default UNCHECKED - BUTTON &#x27;Send&#x27; &quot;screen.getNamedWidget(&#x27;GROUP&#x27;).selected() === 0 ? api.cmd(&#x27;INST ABORT&#x27;) : (screen.getNamedWidget(&#x27;CHECK&#x27;).checked() ? api.cmd_no_hazardous_check(&#x27;INST CLEAR&#x27;) : api.cmd(&#x27;INST CLEAR&#x27;))&quot; - END - SETTING BACKCOLOR 163 185 163 -END -</code></pre></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"></path></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 class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#definitions">Definitions</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#telemetry-screen-definition-files">Telemetry Screen Definition Files</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#new-widgets">New Widgets</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#screen">SCREEN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#end">END</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#stale_time">STALE_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#global_setting">GLOBAL_SETTING</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#global_subsetting">GLOBAL_SUBSETTING</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#setting">SETTING</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#width">WIDTH</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#height">HEIGHT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#margin">MARGIN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#padding">PADDING</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#backcolor">BACKCOLOR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#textcolor">TEXTCOLOR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#bordercolor">BORDERCOLOR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#raw">RAW</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#subsetting">SUBSETTING</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#named_widget">NAMED_WIDGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#layout-widgets">Layout Widgets</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#vertical">VERTICAL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#verticalbox">VERTICALBOX</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#horizontal">HORIZONTAL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#horizontalbox">HORIZONTALBOX</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#matrixbycolumns">MATRIXBYCOLUMNS</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#scrollwindow">SCROLLWINDOW</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#tabbook">TABBOOK</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#tabitem">TABITEM</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#iframe">IFRAME</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#decoration-widgets">Decoration Widgets</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#label">LABEL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#horizontalline">HORIZONTALLINE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#sectionheader">SECTIONHEADER</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#title">TITLE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#spacer">SPACER</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#telemetry-widgets">Telemetry Widgets</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#array">ARRAY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#block">BLOCK</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#formatvalue">FORMATVALUE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelled">LABELLED</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#led_color">LED_COLOR</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelprogressbar">LABELPROGRESSBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelvalue">LABELVALUE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelvaluedesc">LABELVALUEDESC</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelvaluelimitsbar">LABELVALUELIMITSBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelvaluelimitscolumn">LABELVALUELIMITSCOLUMN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelvaluerangebar">LABELVALUERANGEBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#led">LED</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#led_color-1">LED_COLOR</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#limitsbar">LIMITSBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#limitscolumn">LIMITSCOLUMN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#limitscolor">LIMITSCOLOR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#valuelimitsbar">VALUELIMITSBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#valuelimitscolumn">VALUELIMITSCOLUMN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#valuerangebar">VALUERANGEBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#linegraph">LINEGRAPH</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#item">ITEM</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#starttime">STARTTIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#history">HISTORY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#secondsgraphed">SECONDSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointssaved">POINTSSAVED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointsgraphed">POINTSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#size">SIZE</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#sparkline">SPARKLINE</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#item-1">ITEM</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#starttime-1">STARTTIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#history-1">HISTORY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#secondsgraphed-1">SECONDSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointssaved-1">POINTSSAVED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointsgraphed-1">POINTSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#size-1">SIZE</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#labelsparkline">LABELSPARKLINE</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#item-2">ITEM</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#starttime-2">STARTTIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#history-2">HISTORY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#secondsgraphed-2">SECONDSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointssaved-2">POINTSSAVED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#pointsgraphed-2">POINTSGRAPHED</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#size-2">SIZE</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#imageviewer">IMAGEVIEWER</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#progressbar">PROGRESSBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#rangebar">RANGEBAR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#rollup">ROLLUP</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#textbox">TEXTBOX</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#value">VALUE</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#interactive-widgets">Interactive Widgets</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#button">BUTTON</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#checkbutton">CHECKBUTTON</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#combobox">COMBOBOX</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#radiogroup">RADIOGROUP</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#radiobutton">RADIOBUTTON</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#textfield">TEXTFIELD</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvas-widgets">Canvas Widgets</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvas">CANVAS</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvaslabel">CANVASLABEL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvaslabelvalue">CANVASLABELVALUE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasimage">CANVASIMAGE</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#screen-1">SCREEN</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasimagevalue">CANVASIMAGEVALUE</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#image">IMAGE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#screen-2">SCREEN</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasline">CANVASLINE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvaslinevalue">CANVASLINEVALUE</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#value_eq">VALUE_EQ</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasdot">CANVASDOT</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/telemetry-screens#example-file">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div> +<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)">&quot;&lt;%= target_name %&gt; Commanding Examples&quot;</span><span class="token plain"></span><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)">&quot;Send Collect Command:&quot;</span><span class="token plain"></span><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)">&quot;Type: &quot;</span><span class="token plain"></span><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)">&quot; Duration: &quot;</span><span class="token plain"></span><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)">&quot;10.0&quot;</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)">&#x27;Start Collect&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;api.cmd(&#x27;INST COLLECT with TYPE &#x27;+screen.getNamedWidget(&#x27;COLLECT_TYPE&#x27;).text()+&#x27;, DURATION &#x27;+screen.getNamedWidget(&#x27;DURATION&#x27;).text())&quot;</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)">&quot;Parameter-less Commands:&quot;</span><span class="token plain"></span><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 &#x27;Clear&#x27; 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)">&#x27;Abort&#x27;</span><span class="token plain"></span><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)">&#x27;Clear&#x27;</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)">&#x27;Ignore Hazardous Checks&#x27;</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)">&#x27;Send&#x27;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;screen.getNamedWidget(&#x27;GROUP&#x27;).selected() === 0 ? api.cmd(&#x27;INST ABORT&#x27;) : (screen.getNamedWidget(&#x27;CHECK&#x27;).checked() ? api.cmd_no_hazardous_check(&#x27;INST CLEAR&#x27;) : api.cmd(&#x27;INST CLEAR&#x27;))&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SETTING</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BACKCOLOR</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">185</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">163</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">END</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="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"></path></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><li><a href="#telemetry-screen-definition-files" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets" class="table-of-contents__link toc-highlight">New Widgets</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li><li><a href="#end" class="table-of-contents__link toc-highlight">END</a></li><li><a href="#stale_time" class="table-of-contents__link toc-highlight">STALE_TIME</a></li><li><a href="#global_setting" class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a></li><li><a href="#global_subsetting" class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a></li><li><a href="#setting" class="table-of-contents__link toc-highlight">SETTING</a><ul><li><a href="#width" class="table-of-contents__link toc-highlight">WIDTH</a></li><li><a href="#height" class="table-of-contents__link toc-highlight">HEIGHT</a></li><li><a href="#margin" class="table-of-contents__link toc-highlight">MARGIN</a></li><li><a href="#padding" class="table-of-contents__link toc-highlight">PADDING</a></li><li><a href="#backcolor" class="table-of-contents__link toc-highlight">BACKCOLOR</a></li><li><a href="#textcolor" class="table-of-contents__link toc-highlight">TEXTCOLOR</a></li><li><a href="#bordercolor" class="table-of-contents__link toc-highlight">BORDERCOLOR</a></li><li><a href="#raw" class="table-of-contents__link toc-highlight">RAW</a></li></ul></li><li><a href="#subsetting" class="table-of-contents__link toc-highlight">SUBSETTING</a></li><li><a href="#named_widget" class="table-of-contents__link toc-highlight">NAMED_WIDGET</a></li><li><a href="#layout-widgets" class="table-of-contents__link toc-highlight">Layout Widgets</a><ul><li><a href="#vertical" class="table-of-contents__link toc-highlight">VERTICAL</a></li><li><a href="#verticalbox" class="table-of-contents__link toc-highlight">VERTICALBOX</a></li><li><a href="#horizontal" class="table-of-contents__link toc-highlight">HORIZONTAL</a></li><li><a href="#horizontalbox" class="table-of-contents__link toc-highlight">HORIZONTALBOX</a></li><li><a href="#matrixbycolumns" class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a></li><li><a href="#scrollwindow" class="table-of-contents__link toc-highlight">SCROLLWINDOW</a></li><li><a href="#tabbook" class="table-of-contents__link toc-highlight">TABBOOK</a></li><li><a href="#tabitem" class="table-of-contents__link toc-highlight">TABITEM</a></li><li><a href="#iframe" class="table-of-contents__link toc-highlight">IFRAME</a></li></ul></li><li><a href="#decoration-widgets" class="table-of-contents__link toc-highlight">Decoration Widgets</a><ul><li><a href="#label" class="table-of-contents__link toc-highlight">LABEL</a></li><li><a href="#horizontalline" class="table-of-contents__link toc-highlight">HORIZONTALLINE</a></li><li><a href="#sectionheader" class="table-of-contents__link toc-highlight">SECTIONHEADER</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">TITLE</a></li><li><a href="#spacer" class="table-of-contents__link toc-highlight">SPACER</a></li></ul></li><li><a href="#telemetry-widgets" class="table-of-contents__link toc-highlight">Telemetry Widgets</a><ul><li><a href="#array" class="table-of-contents__link toc-highlight">ARRAY</a></li><li><a href="#block" class="table-of-contents__link toc-highlight">BLOCK</a></li><li><a href="#formatvalue" class="table-of-contents__link toc-highlight">FORMATVALUE</a></li><li><a href="#labelled" class="table-of-contents__link toc-highlight">LABELLED</a><ul><li><a href="#led_color" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#labelprogressbar" class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a></li><li><a href="#labelvalue" class="table-of-contents__link toc-highlight">LABELVALUE</a></li><li><a href="#labelvaluedesc" class="table-of-contents__link toc-highlight">LABELVALUEDESC</a></li><li><a href="#labelvaluelimitsbar" class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a></li><li><a href="#labelvaluelimitscolumn" class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a></li><li><a href="#labelvaluerangebar" class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a></li><li><a href="#led" class="table-of-contents__link toc-highlight">LED</a><ul><li><a href="#led_color-1" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#limitsbar" class="table-of-contents__link toc-highlight">LIMITSBAR</a></li><li><a href="#limitscolumn" class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a></li><li><a href="#limitscolor" class="table-of-contents__link toc-highlight">LIMITSCOLOR</a></li><li><a href="#valuelimitsbar" class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a></li><li><a href="#valuelimitscolumn" class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a></li><li><a href="#valuerangebar" class="table-of-contents__link toc-highlight">VALUERANGEBAR</a></li><li><a href="#linegraph" class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#sparkline" class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href="#item-1" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-1" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-1" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-1" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-1" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-1" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-1" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#labelsparkline" class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href="#item-2" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-2" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-2" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-2" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-2" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-2" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-2" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#imageviewer" class="table-of-contents__link toc-highlight">IMAGEVIEWER</a></li><li><a href="#progressbar" class="table-of-contents__link toc-highlight">PROGRESSBAR</a></li><li><a href="#rangebar" class="table-of-contents__link toc-highlight">RANGEBAR</a></li><li><a href="#rollup" class="table-of-contents__link toc-highlight">ROLLUP</a></li><li><a href="#signal" class="table-of-contents__link toc-highlight">SIGNAL</a></li><li><a href="#textbox" class="table-of-contents__link toc-highlight">TEXTBOX</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">VALUE</a></li></ul></li><li><a href="#interactive-widgets" class="table-of-contents__link toc-highlight">Interactive Widgets</a><ul><li><a href="#button" class="table-of-contents__link toc-highlight">BUTTON</a></li><li><a href="#checkbutton" class="table-of-contents__link toc-highlight">CHECKBUTTON</a></li><li><a href="#combobox" class="table-of-contents__link toc-highlight">COMBOBOX</a></li><li><a href="#radiogroup" class="table-of-contents__link toc-highlight">RADIOGROUP</a></li><li><a href="#radiobutton" class="table-of-contents__link toc-highlight">RADIOBUTTON</a></li><li><a href="#textfield" class="table-of-contents__link toc-highlight">TEXTFIELD</a></li></ul></li><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><li><a href="#canvaslabel" class="table-of-contents__link toc-highlight">CANVASLABEL</a></li><li><a href="#canvaslabelvalue" class="table-of-contents__link toc-highlight">CANVASLABELVALUE</a></li><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></li></ul></li><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><li><a href="#screen-2" class="table-of-contents__link toc-highlight">SCREEN</a></li></ul></li><li><a href="#canvasline" class="table-of-contents__link toc-highlight">CANVASLINE</a></li><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></li></ul></li><li><a href="#canvasdot" class="table-of-contents__link toc-highlight">CANVASDOT</a></li></ul></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div> </body> </html> \ No newline at end of file