openc3-cosmos-tool-docs 5.15.1 → 5.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +3 -3
- data/tools/staticdocs/assets/css/styles.a9c55efa.css +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.299bf4d6.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.f103f64b.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.bbf2813b.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.b24d0393.js +1 -0
- data/tools/staticdocs/assets/js/{aa6b6c1b.6281c551.js → aa6b6c1b.a13cb467.js} +1 -1
- data/tools/staticdocs/assets/js/b6d70f94.20a403bf.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.534d50e4.js +1 -0
- data/tools/staticdocs/assets/js/{main.abd362be.js → main.9ed8621d.js} +2 -2
- data/tools/staticdocs/assets/js/{runtime~main.7575b058.js → runtime~main.c6bb8b5e.js} +1 -1
- data/tools/staticdocs/docs/configuration/command.html +3 -3
- data/tools/staticdocs/docs/configuration/format.html +3 -3
- data/tools/staticdocs/docs/configuration/interfaces.html +3 -3
- data/tools/staticdocs/docs/configuration/plugins.html +7 -4
- data/tools/staticdocs/docs/configuration/protocols.html +14 -6
- data/tools/staticdocs/docs/configuration/ssl-tls.html +3 -3
- data/tools/staticdocs/docs/configuration/table.html +3 -3
- data/tools/staticdocs/docs/configuration/target.html +3 -3
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +6 -22
- data/tools/staticdocs/docs/configuration/telemetry.html +7 -4
- data/tools/staticdocs/docs/configuration.html +3 -3
- data/tools/staticdocs/docs/development/curl.html +90 -4
- data/tools/staticdocs/docs/development/developing.html +3 -3
- data/tools/staticdocs/docs/development/host-install.html +3 -3
- data/tools/staticdocs/docs/development/json-api.html +3 -3
- data/tools/staticdocs/docs/development/log-structure.html +3 -3
- data/tools/staticdocs/docs/development/roadmap.html +3 -3
- data/tools/staticdocs/docs/development/streaming-api.html +3 -3
- data/tools/staticdocs/docs/development/testing.html +3 -3
- data/tools/staticdocs/docs/development.html +3 -3
- data/tools/staticdocs/docs/getting-started/generators.html +3 -3
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +3 -3
- data/tools/staticdocs/docs/getting-started/installation.html +3 -3
- data/tools/staticdocs/docs/getting-started/key_concepts.html +3 -3
- data/tools/staticdocs/docs/getting-started/podman.html +3 -3
- data/tools/staticdocs/docs/getting-started/requirements.html +3 -3
- data/tools/staticdocs/docs/getting-started/upgrading.html +3 -3
- data/tools/staticdocs/docs/getting-started.html +3 -3
- data/tools/staticdocs/docs/guides/bridges.html +3 -3
- data/tools/staticdocs/docs/guides/cfs.html +3 -3
- data/tools/staticdocs/docs/guides/custom-widgets.html +3 -3
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -3
- data/tools/staticdocs/docs/guides/local-mode.html +3 -3
- data/tools/staticdocs/docs/guides/logging.html +3 -3
- data/tools/staticdocs/docs/guides/monitoring.html +3 -3
- data/tools/staticdocs/docs/guides/performance.html +3 -3
- data/tools/staticdocs/docs/guides/raspberrypi.html +14 -13
- data/tools/staticdocs/docs/guides/script-writing.html +3 -3
- data/tools/staticdocs/docs/guides/scripting-api.html +45 -37
- data/tools/staticdocs/docs/guides.html +3 -3
- data/tools/staticdocs/docs/meta/contributing.html +3 -3
- data/tools/staticdocs/docs/meta/licenses.html +3 -3
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/xtce.html +3 -3
- data/tools/staticdocs/docs/meta.html +3 -3
- data/tools/staticdocs/docs/privacy.html +3 -3
- data/tools/staticdocs/docs/tools/autonomic.html +3 -3
- data/tools/staticdocs/docs/tools/bucket-explorer.html +3 -3
- data/tools/staticdocs/docs/tools/calendar.html +3 -3
- data/tools/staticdocs/docs/tools/cmd-sender.html +3 -3
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +3 -3
- data/tools/staticdocs/docs/tools/data-extractor.html +3 -3
- data/tools/staticdocs/docs/tools/data-viewer.html +3 -3
- data/tools/staticdocs/docs/tools/handbooks.html +3 -3
- data/tools/staticdocs/docs/tools/limits-monitor.html +3 -3
- data/tools/staticdocs/docs/tools/packet-viewer.html +3 -3
- data/tools/staticdocs/docs/tools/script-runner.html +3 -3
- data/tools/staticdocs/docs/tools/table-manager.html +3 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +3 -3
- data/tools/staticdocs/docs/tools/tlm-viewer.html +3 -3
- data/tools/staticdocs/docs/tools.html +3 -3
- data/tools/staticdocs/docs.html +3 -3
- data/tools/staticdocs/index.html +3 -3
- data/tools/staticdocs/lunr-index-1714800805056.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1714800805056.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +15 -15
- data/tools/staticdocs/assets/css/styles.a4426211.css +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.77516494.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.e29e2db3.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.a77e4761.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.66b19930.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.66d95cb7.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.0b19ae07.js +0 -1
- data/tools/staticdocs/lunr-index-1710527361977.json +0 -1
- data/tools/staticdocs/search-doc-1710527361977.json +0 -1
- /data/tools/staticdocs/assets/js/{main.abd362be.js.LICENSE.txt → main.9ed8621d.js.LICENSE.txt} +0 -0
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
|
-
<title data-rh="true">Targets | 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/target"><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="Targets | OpenC3 Docs"><meta data-rh="true" name="description" content="Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target."><meta data-rh="true" property="og:description" content="Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target."><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/target"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/target" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/target" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
6
|
+
<title data-rh="true">Targets | 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/target"><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="Targets | OpenC3 Docs"><meta data-rh="true" name="description" content="Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target."><meta data-rh="true" property="og:description" content="Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target."><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/target"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/target" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/target" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.c6bb8b5e.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.9ed8621d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" 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" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Targets</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"><p>Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level <a href="/tools/staticdocs/docs/configuration/plugins#target-1">TARGET</a> keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target.</p>
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
|
-
<title data-rh="true">Screens | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Screens | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><meta data-rh="true" property="og:description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
6
|
+
<title data-rh="true">Screens | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Screens | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><meta data-rh="true" property="og:description" content="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry-screens" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.c6bb8b5e.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.9ed8621d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Screens</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Screens</h1></header><p>This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p>
|
|
@@ -568,21 +568,9 @@ can be used to send commands and perform other tasks. If you want your button
|
|
|
568
568
|
to use values from other widgets, define them as named widgets and read their
|
|
569
569
|
values using the <code>screen.getNamedWidget("WIDGET_NAME").text()</code> method.
|
|
570
570
|
See the example in CHECKBUTTON.</p>
|
|
571
|
-
<
|
|
571
|
+
<p>Button code can get rather complex so remember to use string concatenation
|
|
572
572
|
to make things more readable. If you use <code>+</code> newlines are inserted automatically
|
|
573
|
-
during string concatenation. If you use
|
|
574
|
-
sidebar_position: 9
|
|
575
|
-
title: Screens</h2>
|
|
576
|
-
<p>This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p>
|
|
577
|
-
<div style="clear:both"></div>
|
|
578
|
-
<h2 id="definitions-1">Definitions</h2>
|
|
579
|
-
<table><thead><tr><th>Name</th><th>Definition</th></tr></thead><tbody><tr><td>Widget</td><td>A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task.</td></tr><tr><td>Screen</td><td>A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion.</td></tr><tr><td>Screen Definition File</td><td>A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them.</td></tr></tbody></table>
|
|
580
|
-
<h2 id="telemetry-screen-definition-files-1">Telemetry Screen Definition Files</h2>
|
|
581
|
-
<p>Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target's screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase.</p>
|
|
582
|
-
<h2 id="new-widgets-1">New Widgets</h2>
|
|
583
|
-
<p>When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide.</p>
|
|
584
|
-
<h1 id="screen-keywords-1">Screen Keywords</h1>
|
|
585
|
-
<p>you'll need to separate lines with a
|
|
573
|
+
during string concatenation. If you use <code>\</code> you'll need to separate lines with a
|
|
586
574
|
single semicolon <code>;</code>. COSMOS uses double semicolon <code>;;</code> to indicate lines should
|
|
587
575
|
be evaluated separately. Note that all OpenC3 commands (using api.cmd) must be
|
|
588
576
|
separated by <code>;;</code>.</p>
|
|
@@ -775,10 +763,6 @@ VERTICAL
|
|
|
775
763
|
END
|
|
776
764
|
SETTING BACKCOLOR 163 185 163
|
|
777
765
|
END
|
|
778
|
-
</code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry-screens.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/table"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Tables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/ssl-tls"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">SSL-TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#definitions" class="table-of-contents__link toc-highlight">Definitions</a></li><li><a href="#telemetry-screen-definition-files" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets" class="table-of-contents__link toc-highlight">New Widgets</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li><li><a href="#end" class="table-of-contents__link toc-highlight">END</a></li><li><a href="#stale_time" class="table-of-contents__link toc-highlight">STALE_TIME</a></li><li><a href="#global_setting" class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a></li><li><a href="#global_subsetting" class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a></li><li><a href="#setting" class="table-of-contents__link toc-highlight">SETTING</a><ul><li><a href="#width" class="table-of-contents__link toc-highlight">WIDTH</a></li><li><a href="#height" class="table-of-contents__link toc-highlight">HEIGHT</a></li><li><a href="#margin" class="table-of-contents__link toc-highlight">MARGIN</a></li><li><a href="#padding" class="table-of-contents__link toc-highlight">PADDING</a></li><li><a href="#backcolor" class="table-of-contents__link toc-highlight">BACKCOLOR</a></li><li><a href="#textcolor" class="table-of-contents__link toc-highlight">TEXTCOLOR</a></li><li><a href="#bordercolor" class="table-of-contents__link toc-highlight">BORDERCOLOR</a></li><li><a href="#raw" class="table-of-contents__link toc-highlight">RAW</a></li></ul></li><li><a href="#subsetting" class="table-of-contents__link toc-highlight">SUBSETTING</a></li><li><a href="#named_widget" class="table-of-contents__link toc-highlight">NAMED_WIDGET</a></li><li><a href="#layout-widgets" class="table-of-contents__link toc-highlight">Layout Widgets</a><ul><li><a href="#vertical" class="table-of-contents__link toc-highlight">VERTICAL</a></li><li><a href="#verticalbox" class="table-of-contents__link toc-highlight">VERTICALBOX</a></li><li><a href="#horizontal" class="table-of-contents__link toc-highlight">HORIZONTAL</a></li><li><a href="#horizontalbox" class="table-of-contents__link toc-highlight">HORIZONTALBOX</a></li><li><a href="#matrixbycolumns" class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a></li><li><a href="#scrollwindow" class="table-of-contents__link toc-highlight">SCROLLWINDOW</a></li><li><a href="#tabbook" class="table-of-contents__link toc-highlight">TABBOOK</a></li><li><a href="#tabitem" class="table-of-contents__link toc-highlight">TABITEM</a></li><li><a href="#iframe" class="table-of-contents__link toc-highlight">IFRAME</a></li></ul></li><li><a href="#decoration-widgets" class="table-of-contents__link toc-highlight">Decoration Widgets</a><ul><li><a href="#label" class="table-of-contents__link toc-highlight">LABEL</a></li><li><a href="#horizontalline" class="table-of-contents__link toc-highlight">HORIZONTALLINE</a></li><li><a href="#sectionheader" class="table-of-contents__link toc-highlight">SECTIONHEADER</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">TITLE</a></li><li><a href="#spacer" class="table-of-contents__link toc-highlight">SPACER</a></li></ul></li><li><a href="#telemetry-widgets" class="table-of-contents__link toc-highlight">Telemetry Widgets</a><ul><li><a href="#array" class="table-of-contents__link toc-highlight">ARRAY</a></li><li><a href="#block" class="table-of-contents__link toc-highlight">BLOCK</a></li><li><a href="#formatvalue" class="table-of-contents__link toc-highlight">FORMATVALUE</a></li><li><a href="#labelled" class="table-of-contents__link toc-highlight">LABELLED</a><ul><li><a href="#led_color" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#labelprogressbar" class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a></li><li><a href="#labelvalue" class="table-of-contents__link toc-highlight">LABELVALUE</a></li><li><a href="#labelvaluedesc" class="table-of-contents__link toc-highlight">LABELVALUEDESC</a></li><li><a href="#labelvaluelimitsbar" class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a></li><li><a href="#labelvaluelimitscolumn" class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a></li><li><a href="#labelvaluerangebar" class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a></li><li><a href="#led" class="table-of-contents__link toc-highlight">LED</a><ul><li><a href="#led_color-1" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#limitsbar" class="table-of-contents__link toc-highlight">LIMITSBAR</a></li><li><a href="#limitscolumn" class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a></li><li><a href="#limitscolor" class="table-of-contents__link toc-highlight">LIMITSCOLOR</a></li><li><a href="#valuelimitsbar" class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a></li><li><a href="#valuelimitscolumn" class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a></li><li><a href="#valuerangebar" class="table-of-contents__link toc-highlight">VALUERANGEBAR</a></li><li><a href="#linegraph" class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#sparkline" class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href="#item-1" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-1" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-1" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-1" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-1" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-1" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-1" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#labelsparkline" class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href="#item-2" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-2" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-2" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-2" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-2" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-2" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-2" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#imageviewer" class="table-of-contents__link toc-highlight">IMAGEVIEWER</a></li><li><a href="#progressbar" class="table-of-contents__link toc-highlight">PROGRESSBAR</a></li><li><a href="#rangebar" class="table-of-contents__link toc-highlight">RANGEBAR</a></li><li><a href="#textbox" class="table-of-contents__link toc-highlight">TEXTBOX</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">VALUE</a></li></ul></li><li><a href="#interactive-widgets" class="table-of-contents__link toc-highlight">Interactive Widgets</a><ul><li><a href="#button" class="table-of-contents__link toc-highlight">BUTTON</a></li></ul></li><li><a href="#button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens" class="table-of-contents__link toc-highlight">Button code can get rather complex so remember to use string concatenation
|
|
779
|
-
to make things more readable. If you use <code>+</code> newlines are inserted automatically
|
|
780
|
-
during string concatenation. If you use `---
|
|
781
|
-
sidebar_position: 9
|
|
782
|
-
title: Screens</a></li><li><a href="#definitions-1" class="table-of-contents__link toc-highlight">Definitions</a></li><li><a href="#telemetry-screen-definition-files-1" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets-1" class="table-of-contents__link toc-highlight">New Widgets</a><ul><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>
|
|
766
|
+
</code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry-screens.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/table"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Tables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/ssl-tls"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">SSL-TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#definitions" class="table-of-contents__link toc-highlight">Definitions</a></li><li><a href="#telemetry-screen-definition-files" class="table-of-contents__link toc-highlight">Telemetry Screen Definition Files</a></li><li><a href="#new-widgets" class="table-of-contents__link toc-highlight">New Widgets</a></li><li><a href="#screen" class="table-of-contents__link toc-highlight">SCREEN</a></li><li><a href="#end" class="table-of-contents__link toc-highlight">END</a></li><li><a href="#stale_time" class="table-of-contents__link toc-highlight">STALE_TIME</a></li><li><a href="#global_setting" class="table-of-contents__link toc-highlight">GLOBAL_SETTING</a></li><li><a href="#global_subsetting" class="table-of-contents__link toc-highlight">GLOBAL_SUBSETTING</a></li><li><a href="#setting" class="table-of-contents__link toc-highlight">SETTING</a><ul><li><a href="#width" class="table-of-contents__link toc-highlight">WIDTH</a></li><li><a href="#height" class="table-of-contents__link toc-highlight">HEIGHT</a></li><li><a href="#margin" class="table-of-contents__link toc-highlight">MARGIN</a></li><li><a href="#padding" class="table-of-contents__link toc-highlight">PADDING</a></li><li><a href="#backcolor" class="table-of-contents__link toc-highlight">BACKCOLOR</a></li><li><a href="#textcolor" class="table-of-contents__link toc-highlight">TEXTCOLOR</a></li><li><a href="#bordercolor" class="table-of-contents__link toc-highlight">BORDERCOLOR</a></li><li><a href="#raw" class="table-of-contents__link toc-highlight">RAW</a></li></ul></li><li><a href="#subsetting" class="table-of-contents__link toc-highlight">SUBSETTING</a></li><li><a href="#named_widget" class="table-of-contents__link toc-highlight">NAMED_WIDGET</a></li><li><a href="#layout-widgets" class="table-of-contents__link toc-highlight">Layout Widgets</a><ul><li><a href="#vertical" class="table-of-contents__link toc-highlight">VERTICAL</a></li><li><a href="#verticalbox" class="table-of-contents__link toc-highlight">VERTICALBOX</a></li><li><a href="#horizontal" class="table-of-contents__link toc-highlight">HORIZONTAL</a></li><li><a href="#horizontalbox" class="table-of-contents__link toc-highlight">HORIZONTALBOX</a></li><li><a href="#matrixbycolumns" class="table-of-contents__link toc-highlight">MATRIXBYCOLUMNS</a></li><li><a href="#scrollwindow" class="table-of-contents__link toc-highlight">SCROLLWINDOW</a></li><li><a href="#tabbook" class="table-of-contents__link toc-highlight">TABBOOK</a></li><li><a href="#tabitem" class="table-of-contents__link toc-highlight">TABITEM</a></li><li><a href="#iframe" class="table-of-contents__link toc-highlight">IFRAME</a></li></ul></li><li><a href="#decoration-widgets" class="table-of-contents__link toc-highlight">Decoration Widgets</a><ul><li><a href="#label" class="table-of-contents__link toc-highlight">LABEL</a></li><li><a href="#horizontalline" class="table-of-contents__link toc-highlight">HORIZONTALLINE</a></li><li><a href="#sectionheader" class="table-of-contents__link toc-highlight">SECTIONHEADER</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">TITLE</a></li><li><a href="#spacer" class="table-of-contents__link toc-highlight">SPACER</a></li></ul></li><li><a href="#telemetry-widgets" class="table-of-contents__link toc-highlight">Telemetry Widgets</a><ul><li><a href="#array" class="table-of-contents__link toc-highlight">ARRAY</a></li><li><a href="#block" class="table-of-contents__link toc-highlight">BLOCK</a></li><li><a href="#formatvalue" class="table-of-contents__link toc-highlight">FORMATVALUE</a></li><li><a href="#labelled" class="table-of-contents__link toc-highlight">LABELLED</a><ul><li><a href="#led_color" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#labelprogressbar" class="table-of-contents__link toc-highlight">LABELPROGRESSBAR</a></li><li><a href="#labelvalue" class="table-of-contents__link toc-highlight">LABELVALUE</a></li><li><a href="#labelvaluedesc" class="table-of-contents__link toc-highlight">LABELVALUEDESC</a></li><li><a href="#labelvaluelimitsbar" class="table-of-contents__link toc-highlight">LABELVALUELIMITSBAR</a></li><li><a href="#labelvaluelimitscolumn" class="table-of-contents__link toc-highlight">LABELVALUELIMITSCOLUMN</a></li><li><a href="#labelvaluerangebar" class="table-of-contents__link toc-highlight">LABELVALUERANGEBAR</a></li><li><a href="#led" class="table-of-contents__link toc-highlight">LED</a><ul><li><a href="#led_color-1" class="table-of-contents__link toc-highlight">LED_COLOR</a></li></ul></li><li><a href="#limitsbar" class="table-of-contents__link toc-highlight">LIMITSBAR</a></li><li><a href="#limitscolumn" class="table-of-contents__link toc-highlight">LIMITSCOLUMN</a></li><li><a href="#limitscolor" class="table-of-contents__link toc-highlight">LIMITSCOLOR</a></li><li><a href="#valuelimitsbar" class="table-of-contents__link toc-highlight">VALUELIMITSBAR</a></li><li><a href="#valuelimitscolumn" class="table-of-contents__link toc-highlight">VALUELIMITSCOLUMN</a></li><li><a href="#valuerangebar" class="table-of-contents__link toc-highlight">VALUERANGEBAR</a></li><li><a href="#linegraph" class="table-of-contents__link toc-highlight">LINEGRAPH</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#sparkline" class="table-of-contents__link toc-highlight">SPARKLINE</a><ul><li><a href="#item-1" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-1" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-1" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-1" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-1" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-1" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-1" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#labelsparkline" class="table-of-contents__link toc-highlight">LABELSPARKLINE</a><ul><li><a href="#item-2" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#starttime-2" class="table-of-contents__link toc-highlight">STARTTIME</a></li><li><a href="#history-2" class="table-of-contents__link toc-highlight">HISTORY</a></li><li><a href="#secondsgraphed-2" class="table-of-contents__link toc-highlight">SECONDSGRAPHED</a></li><li><a href="#pointssaved-2" class="table-of-contents__link toc-highlight">POINTSSAVED</a></li><li><a href="#pointsgraphed-2" class="table-of-contents__link toc-highlight">POINTSGRAPHED</a></li><li><a href="#size-2" class="table-of-contents__link toc-highlight">SIZE</a></li></ul></li><li><a href="#imageviewer" class="table-of-contents__link toc-highlight">IMAGEVIEWER</a></li><li><a href="#progressbar" class="table-of-contents__link toc-highlight">PROGRESSBAR</a></li><li><a href="#rangebar" class="table-of-contents__link toc-highlight">RANGEBAR</a></li><li><a href="#textbox" class="table-of-contents__link toc-highlight">TEXTBOX</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">VALUE</a></li></ul></li><li><a href="#interactive-widgets" class="table-of-contents__link toc-highlight">Interactive Widgets</a><ul><li><a href="#button" class="table-of-contents__link toc-highlight">BUTTON</a></li><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>
|
|
783
767
|
</body>
|
|
784
768
|
</html>
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
|
-
<title data-rh="true">Telemetry | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Telemetry | OpenC3 Docs"><meta data-rh="true" name="description" content="Telemetry Definition Files"><meta data-rh="true" property="og:description" content="Telemetry Definition Files"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
6
|
+
<title data-rh="true">Telemetry | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Telemetry | OpenC3 Docs"><meta data-rh="true" name="description" content="Telemetry Definition Files"><meta data-rh="true" property="og:description" content="Telemetry Definition Files"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.c6bb8b5e.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.9ed8621d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Telemetry</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Telemetry</h1></header><h2 id="telemetry-definition-files">Telemetry Definition Files</h2>
|
|
@@ -234,6 +234,9 @@ LIMITS TVAC 3 ENABLED -80.0 -30.0 30.0 80.0
|
|
|
234
234
|
<p></p><div class="right">(Since 5.0.10)</div><strong>Defines the class used to read and write raw values from the packet</strong><p></p>
|
|
235
235
|
<p>Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.</p>
|
|
236
236
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Accessor Class Name</td><td>The name of the accessor class</td><td>True</td></tr></tbody></table>
|
|
237
|
+
<h3 id="ignore_overlap">IGNORE_OVERLAP</h3>
|
|
238
|
+
<p></p><div class="right">(Since 5.15.3)</div><strong>Ignores any packet items which overlap</strong><p></p>
|
|
239
|
+
<p>Packet items which overlap normally generate a warning unless each individual item has the OVERLAP keyword. This ignores overlaps across the entire packet.</p>
|
|
237
240
|
<h2 id="select_telemetry">SELECT_TELEMETRY</h2>
|
|
238
241
|
<p><strong>Selects an existing telemetry packet for editing</strong></p>
|
|
239
242
|
<p>Typically used in a separate configuration file from where the original telemetry is defined to override or add to the existing telemetry definition. Must be used in conjunction with SELECT_ITEM to change an individual item.</p>
|
|
@@ -293,6 +296,6 @@ LIMITS TVAC 3 ENABLED -80.0 -30.0 30.0 80.0
|
|
|
293
296
|
time = Time.ccsds2mdy(packet.read('ccsdsday'), packet.read('ccsdsmsod'), packet.read('ccsdsusoms'))
|
|
294
297
|
sprintf('%04u/%02u/%02u %02u:%02u:%02u.%06u', time[0], time[1], time[2], time[3], time[4], time[5], time[6])
|
|
295
298
|
GENERIC_READ_CONVERSION_END
|
|
296
|
-
</code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/command"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interfaces</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#telemetry-definition-files" class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href="#id-items" class="table-of-contents__link toc-highlight">ID Items</a></li><li><a href="#variable-sized-items" class="table-of-contents__link toc-highlight">Variable Sized Items</a></li><li><a href="#derived-items" class="table-of-contents__link toc-highlight">Derived Items</a></li><li><a href="#received-time-and-packet-time" class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li></ul></li></ul></li><li><a href="#telemetry" class="table-of-contents__link toc-highlight">TELEMETRY</a></li><li><a href="#telemetry-modifiers" class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#item-modifiers" class="table-of-contents__link toc-highlight">ITEM Modifiers</a><ul><li><a href="#format_string" class="table-of-contents__link toc-highlight">FORMAT_STRING</a></li><li><a href="#units" class="table-of-contents__link toc-highlight">UNITS</a></li><li><a href="#description" class="table-of-contents__link toc-highlight">DESCRIPTION</a></li><li><a href="#meta" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#overlap" class="table-of-contents__link toc-highlight">OVERLAP</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#read_conversion" class="table-of-contents__link toc-highlight">READ_CONVERSION</a></li><li><a href="#poly_read_conversion" class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a></li><li><a href="#seg_poly_read_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a></li><li><a href="#generic_read_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a></li><li><a href="#generic_read_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a></li><li><a href="#limits" class="table-of-contents__link toc-highlight">LIMITS</a></li><li><a href="#limits_response" class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></li></ul></li><li><a href="#append_item" class="table-of-contents__link toc-highlight">APPEND_ITEM</a></li><li><a href="#id_item" class="table-of-contents__link toc-highlight">ID_ITEM</a></li><li><a href="#append_id_item" class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a></li><li><a href="#array_item" class="table-of-contents__link toc-highlight">ARRAY_ITEM</a></li><li><a href="#append_array_item" class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a></li><li><a href="#select_item" class="table-of-contents__link toc-highlight">SELECT_ITEM</a></li><li><a href="#delete_item" class="table-of-contents__link toc-highlight">DELETE_ITEM</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#processor" class="table-of-contents__link toc-highlight">PROCESSOR</a></li><li><a href="#allow_short" class="table-of-contents__link toc-highlight">ALLOW_SHORT</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li></ul></li><li><a href="#select_telemetry" class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a></li><li><a href="#limits_group" class="table-of-contents__link toc-highlight">LIMITS_GROUP</a></li><li><a href="#limits_group_item" class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</a></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
|
299
|
+
</code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/command"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interfaces</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#telemetry-definition-files" class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href="#id-items" class="table-of-contents__link toc-highlight">ID Items</a></li><li><a href="#variable-sized-items" class="table-of-contents__link toc-highlight">Variable Sized Items</a></li><li><a href="#derived-items" class="table-of-contents__link toc-highlight">Derived Items</a></li><li><a href="#received-time-and-packet-time" class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li></ul></li></ul></li><li><a href="#telemetry" class="table-of-contents__link toc-highlight">TELEMETRY</a></li><li><a href="#telemetry-modifiers" class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#item-modifiers" class="table-of-contents__link toc-highlight">ITEM Modifiers</a><ul><li><a href="#format_string" class="table-of-contents__link toc-highlight">FORMAT_STRING</a></li><li><a href="#units" class="table-of-contents__link toc-highlight">UNITS</a></li><li><a href="#description" class="table-of-contents__link toc-highlight">DESCRIPTION</a></li><li><a href="#meta" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#overlap" class="table-of-contents__link toc-highlight">OVERLAP</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#read_conversion" class="table-of-contents__link toc-highlight">READ_CONVERSION</a></li><li><a href="#poly_read_conversion" class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a></li><li><a href="#seg_poly_read_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a></li><li><a href="#generic_read_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a></li><li><a href="#generic_read_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a></li><li><a href="#limits" class="table-of-contents__link toc-highlight">LIMITS</a></li><li><a href="#limits_response" class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></li></ul></li><li><a href="#append_item" class="table-of-contents__link toc-highlight">APPEND_ITEM</a></li><li><a href="#id_item" class="table-of-contents__link toc-highlight">ID_ITEM</a></li><li><a href="#append_id_item" class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a></li><li><a href="#array_item" class="table-of-contents__link toc-highlight">ARRAY_ITEM</a></li><li><a href="#append_array_item" class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a></li><li><a href="#select_item" class="table-of-contents__link toc-highlight">SELECT_ITEM</a></li><li><a href="#delete_item" class="table-of-contents__link toc-highlight">DELETE_ITEM</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#processor" class="table-of-contents__link toc-highlight">PROCESSOR</a></li><li><a href="#allow_short" class="table-of-contents__link toc-highlight">ALLOW_SHORT</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li><li><a href="#ignore_overlap" class="table-of-contents__link toc-highlight">IGNORE_OVERLAP</a></li></ul></li><li><a href="#select_telemetry" class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a></li><li><a href="#limits_group" class="table-of-contents__link toc-highlight">LIMITS_GROUP</a></li><li><a href="#limits_group_item" class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</a></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
|
297
300
|
</body>
|
|
298
301
|
</html>
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
|
-
<title data-rh="true">Configuration | 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"><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="Configuration | OpenC3 Docs"><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"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
6
|
+
<title data-rh="true">Configuration | 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"><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="Configuration | OpenC3 Docs"><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"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.c6bb8b5e.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.9ed8621d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_ak01"><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 breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Configuration</span><meta itemprop="position" content="1"></li></ul></nav><header><h1 class="title_AulG">Configuration</h1></header><article class="margin-top--lg"><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/format"><h2 class="text--truncate cardTitle_h48N" title="File Format">📄️<!-- --> <!-- -->File Format</h2><p class="text--truncate cardDescription_CytT" title="COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible.">COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/plugins"><h2 class="text--truncate cardTitle_h48N" title="Plugins">📄️<!-- --> <!-- -->Plugins</h2><p class="text--truncate cardDescription_CytT" title="Introduction">Introduction</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/target"><h2 class="text--truncate cardTitle_h48N" title="Targets">📄️<!-- --> <!-- -->Targets</h2><p class="text--truncate cardDescription_CytT" title="Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target.">Targets are the external embedded systems that COSMOS connects to. Targets are defined by the top level TARGET keyword in the plugin.txt file. Each target is self contained in a target directory named after the target. In the root of the target directory there is a configuration file named target.txt which configures the individual target.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/command"><h2 class="text--truncate cardTitle_h48N" title="Commands">📄️<!-- --> <!-- -->Commands</h2><p class="text--truncate cardDescription_CytT" title="Command Definition Files">Command Definition Files</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/telemetry"><h2 class="text--truncate cardTitle_h48N" title="Telemetry">📄️<!-- --> <!-- -->Telemetry</h2><p class="text--truncate cardDescription_CytT" title="Telemetry Definition Files">Telemetry Definition Files</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/interfaces"><h2 class="text--truncate cardTitle_h48N" title="Interfaces">📄️<!-- --> <!-- -->Interfaces</h2><p class="text--truncate cardDescription_CytT" title="Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file.">Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/protocols"><h2 class="text--truncate cardTitle_h48N" title="Protocols">📄️<!-- --> <!-- -->Protocols</h2><p class="text--truncate cardDescription_CytT" title="Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.">Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/table"><h2 class="text--truncate cardTitle_h48N" title="Tables">📄️<!-- --> <!-- -->Tables</h2><p class="text--truncate cardDescription_CytT" title="Table Definition Files">Table Definition Files</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/telemetry-screens"><h2 class="text--truncate cardTitle_h48N" title="Screens">📄️<!-- --> <!-- -->Screens</h2><p class="text--truncate cardDescription_CytT" title="This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.">This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/configuration/ssl-tls"><h2 class="text--truncate cardTitle_h48N" title="SSL-TLS">📄️<!-- --> <!-- -->SSL-TLS</h2><p class="text--truncate cardDescription_CytT" title="COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs.">COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs.</p></a></article></section></article><footer class="margin-top--lg"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/podman"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Podman</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/format"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">File Format</div></a></nav></footer></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>
|