RubyGems - openc3-cosmos-tool-docs - Versions diffs - 5.16.1 → 5.17.0 - Mend

openc3-cosmos-tool-docs 5.16.1 → 5.17.0

Files changed (175) hide show

data/tools/staticdocs/assets/js/696b4199.2700ad91.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4875],{271:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var i=n(1085),r=n(1184);const s={sidebar_position:10,title:"SSL-TLS"},c=void 0,o={id:"configuration/ssl-tls",title:"SSL-TLS",description:"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.",source:"@site/docs/configuration/ssl-tls.md",sourceDirName:"configuration",slug:"/configuration/ssl-tls",permalink:"/tools/staticdocs/docs/configuration/ssl-tls",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/ssl-tls.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10,title:"SSL-TLS"},sidebar:"defaultSidebar",previous:{title:"Screens",permalink:"/tools/staticdocs/docs/configuration/telemetry-screens"},next:{title:"Tools",permalink:"/tools/staticdocs/docs/tools"}},a={},l=[{value:"Generate the certificate",id:"generate-the-certificate",level:3},{value:"Updating the openc3-traefik Dockerfile",id:"updating-the-openc3-traefik-dockerfile",level:3},{value:"Updating the Traefik config",id:"updating-the-traefik-config",level:3},{value:"Update docker-compose.yaml",id:"update-docker-composeyaml",level:3},{value:"Let's Encrypt",id:"lets-encrypt",level:2},{value:"KEY",id:"key",level:4},{value:"CRT",id:"crt",level:4},{value:"CRT/KEY Bundle",id:"crtkey-bundle",level:4},{value:"cert.pem",id:"certpem",level:4},{value:"chain.pem",id:"chainpem",level:4},{value:"Checking certs",id:"checking-certs",level:3},{value:"Extracting the certificate and keys from a .pfx file",id:"extracting-the-certificate-and-keys-from-a-pfx-file",level:2},{value:"Extract .crt and .key files from .pfx file",id:"extract-crt-and-key-files-from-pfx-file",level:3},{value:"Convert .pfx file to .pem format",id:"convert-pfx-file-to-pem-format",level:3},{value:"TLS1.2 INADEQUATE_SECURITY Errors",id:"tls12-inadequate_security-errors",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["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 ",(0,i.jsx)(t.a,{href:"https://doc.traefik.io/traefik/routing/entrypoints/#tls",children:"docs"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"generate-the-certificate",children:"Generate the certificate"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsx)(t.p,{children:"Note: Self-signed certificates are considered insecure for the Internet. Firefox will treat the site as having an invalid certificate, while Chrome will act as if the connection was plain HTTP."}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"To create a new Self-Signed SSL Certificate, use the openssl req command (run on linux from the cosmos-project root):"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openssl req -newkey rsa:4096 \\\n -x509 \\\n -sha256 \\\n -days 3650 \\\n -nodes \\\n -out ./openc3-traefik/cert.crt \\\n -keyout ./openc3-traefik/cert.key\n\nCountry Name (2 letter code) [XX]:.\nState or Province Name (full name) []:.\nLocality Name (eg, city) [Default City]:.\nOrganization Name (eg, company) [Default Company Ltd]:.\nOrganizational Unit Name (eg, section) []:.\nCommon Name (eg, your name or your server hostname) []: \x3c!-- UPDATE WITH YOUR HOSTNAME HERE --\x3e\nEmail Address []:\n"})}),"\n",(0,i.jsx)(t.p,{children:"Let's breakdown the command and understand what each option means:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"newkey rsa:4096"})," - Creates a new certificate request and 4096 bit RSA key. The default one is 2048 bits."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"x509"})," - Creates a X.509 Certificate."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"sha256"})," - Use 265-bit SHA (Secure Hash Algorithm)."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"days 3650"})," - The number of days to certify the certificate for. 3650 is ten years. You can use any positive integer."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"nodes"})," - Creates a key without a passphrase."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"out ./openc3-traefik/cert.crt"})," - Specifies the filename to write the newly created certificate to. You can specify any file name."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"keyout ./openc3-traefik/cert.key"})," - Specifies the filename to write the newly created private key to. You can specify any file name."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["For more information about the ",(0,i.jsx)(t.code,{children:"openssl req"})," command options, visit the ",(0,i.jsx)(t.a,{href:"https://www.openssl.org/docs/man1.0.2/man1/openssl-req.html",children:"OpenSSL req documentation page"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"updating-the-openc3-traefik-dockerfile",children:"Updating the openc3-traefik Dockerfile"}),"\n",(0,i.jsx)(t.p,{children:"Add the new cert to the traefik Docker container."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-diff",children:"--- a/openc3-traefik/Dockerfile\n+++ b/openc3-traefik/Dockerfile\n@@ -1,3 +1,4 @@\n FROM traefik:2.4\n COPY ./traefik.yaml /etc/traefik/traefik.yaml\n+COPY ./cert.crt ./cert.key /etc/certs/\n EXPOSE 80\n"})}),"\n",(0,i.jsx)(t.h3,{id:"updating-the-traefik-config",children:"Updating the Traefik config"}),"\n",(0,i.jsx)(t.p,{children:"Configure Traefik to use the new cert file."}),"\n",(0,i.jsx)(t.p,{children:"openc3-traefik/traefik.yaml"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-diff",children:'--- a/openc3-traefik/traefik.yaml\n+++ b/openc3-traefik/traefik.yaml\n@@ -3,6 +3,17 @@\n+tls:\n+ certificates:\n+ - certFile: "/etc/certs/cert.crt"\n+ keyFile: "/etc/certs/cert.key"\n# Listen for everything coming in on the standard HTTP port\nentrypoints:\n web:\n address: ":2900"\n+ http:\n+ redirections:\n+ entryPoint:\n+ to: websecure\n+ scheme: https\n+ websecure:\n+ address: ":2943"\n+ http:\n+ tls:\n+ domains:\n+ - main: "\x3c!-- UPDATE WITH YOUR HOSTNAME HERE --\x3e"\n'})}),"\n",(0,i.jsx)(t.h3,{id:"update-docker-composeyaml",children:"Update docker-compose.yaml"}),"\n",(0,i.jsx)(t.p,{children:"Update traefik to use secure port 443 instead of port 80."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-diff",children:'--- a/compose.yaml\n+++ b/compose.yaml\n services:\n openc3-minio:\n@@ -70,7 +70,7 @@ services:\n openc3-traefik:\n image: "ballaerospace/openc3-traefik:${OPENC3_TAG}"\n ports:\n- - "80:2900"\n+ - "443:2943"\n restart: "unless-stopped"\n depends_on:\n'})}),"\n",(0,i.jsxs)(t.p,{children:["Now you can run ",(0,i.jsx)(t.code,{children:"./openc3.sh start"})," to rebuild the Traefik container and it should include your new cert file."]}),"\n",(0,i.jsx)(t.h2,{id:"lets-encrypt",children:"Let's Encrypt"}),"\n",(0,i.jsx)(t.h4,{id:"key",children:"KEY"}),"\n",(0,i.jsx)(t.p,{children:'privkey.pem is the "key" file'}),"\n",(0,i.jsx)(t.p,{children:"Sometimes it is named as cert.key or example.com.key."}),"\n",(0,i.jsx)(t.h4,{id:"crt",children:"CRT"}),"\n",(0,i.jsx)(t.p,{children:'fullchain.pem is your "crt" file.'}),"\n",(0,i.jsx)(t.p,{children:"Sometimes it is named as example.com.crt."}),"\n",(0,i.jsx)(t.h4,{id:"crtkey-bundle",children:"CRT/KEY Bundle"}),"\n",(0,i.jsx)(t.p,{children:"bundle.pem would be made like so: cat fullchain.pem privkey.pem > bundle.pem"}),"\n",(0,i.jsx)(t.p,{children:"HAProxy is the only server that I know of that uses bundle.pem."}),"\n",(0,i.jsx)(t.h4,{id:"certpem",children:"cert.pem"}),"\n",(0,i.jsx)(t.p,{children:"cert.pem contains ONLY your certificate, which can only be used by itself if the browser already has the certificate which signed it, which may work in testing (which makes it seem like it may be the right file), but will actually fail for many of your users in production with a security error of untrusted certificate."}),"\n",(0,i.jsx)(t.p,{children:"However, you don't generally use the cert.pem by itself. It's almost always coupled with chain.pem as fullchain.pem."}),"\n",(0,i.jsx)(t.h4,{id:"chainpem",children:"chain.pem"}),"\n",(0,i.jsx)(t.p,{children:"chain.pem is the intermediary signed authority, signed by the root authority - which is what all browsers are guaranteed to have in their pre-built cache."}),"\n",(0,i.jsx)(t.h3,{id:"checking-certs",children:"Checking certs"}),"\n",(0,i.jsx)(t.p,{children:"You can inspect the cert like so:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"openssl x509 -in cert.pem -text -noout\n"})}),"\n",(0,i.jsx)(t.h2,{id:"extracting-the-certificate-and-keys-from-a-pfx-file",children:"Extracting the certificate and keys from a .pfx file"}),"\n",(0,i.jsx)(t.p,{children:"The .pfx file, which is in a PKCS#12 format, contains the SSL certificate (public keys) and the corresponding private keys. You might have to import the certificate and private keys separately in an unencrypted plain text format to use it on another system. This topic provides instructions on how to convert the .pfx file to .crt and .key files."}),"\n",(0,i.jsx)(t.h3,{id:"extract-crt-and-key-files-from-pfx-file",children:"Extract .crt and .key files from .pfx file"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsx)(t.p,{children:"PREREQUISITE: Ensure OpenSSL is installed in the server that contains the SSL certificate."}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Start OpenSSL from the OpenSSL\\bin folder."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Open the command prompt and go to the folder that contains your .pfx file."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Run the following command to extract the private key:"}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"openssl pkcs12 -in [yourfile.pfx] -nocerts -out [drlive.key]\n"})}),"\n",(0,i.jsx)(t.p,{children:"You will be prompted to type the import password. Type the password that you used to protect your keypair when you created the .pfx file. You will be prompted again to provide a new password to protect the .key file that you are creating. Store the password to your key file in a secure place to avoid misuse."}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Run the following command to extract the certificate:"}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"openssl pkcs12 -in [yourfile.pfx] -clcerts -nokeys -out [drlive.crt]\n"})}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Run the following command to decrypt the private key:"}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"openssl rsa -in [drlive.key] -out [drlive-decrypted.key]\n"})}),"\n",(0,i.jsx)(t.p,{children:"Type the password that you created to protect the private key file in the previous step.\nThe .crt file and the decrypted and encrypted .key files are available in the path, where you started OpenSSL."}),"\n",(0,i.jsx)(t.h3,{id:"convert-pfx-file-to-pem-format",children:"Convert .pfx file to .pem format"}),"\n",(0,i.jsx)(t.p,{children:"There might be instances where you might have to convert the .pfx file into .pem format. Run the following command to convert it into PEM format."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{children:"openssl rsa -in [keyfile-encrypted.key] -outform PEM -out [keyfile-encrypted-pem.key]\n"})}),"\n",(0,i.jsx)(t.h2,{id:"tls12-inadequate_security-errors",children:"TLS1.2 INADEQUATE_SECURITY Errors"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://doc.traefik.io/traefik/https/tls/#cipher-suites",children:"https://doc.traefik.io/traefik/https/tls/#cipher-suites"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://pkg.go.dev/crypto/tls#pkg-constants",children:"https://pkg.go.dev/crypto/tls#pkg-constants"})}),"\n"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-yaml",children:"tls:\n options:\n default:\n cipherSuites:\n - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\n - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\n - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\n - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\n - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\n - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\n"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>c});var i=n(4041);const r={},s=i.createContext(r);function c(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}}}]);

data/tools/staticdocs/assets/js/6f92e431.67f5a7a4.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9729],{186:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>r,contentTitle:()=>o,default:()=>m,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var n=t(1085),i=t(1184);const a={title:"Roadmap"},o=void 0,l={id:"development/roadmap",title:"Roadmap",description:"Key Features Still to Come in OpenC3 COSMOS 5.x:",source:"@site/docs/development/roadmap.md",sourceDirName:"development",slug:"/development/roadmap",permalink:"/tools/staticdocs/docs/development/roadmap",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/roadmap.md",tags:[],version:"current",frontMatter:{title:"Roadmap"},sidebar:"defaultSidebar",previous:{title:"Log Structure",permalink:"/tools/staticdocs/docs/development/log-structure"},next:{title:"Streaming API",permalink:"/tools/staticdocs/docs/development/streaming-api"}},r={},c=[{value:"Key Features Still to Come in OpenC3 COSMOS 5.x:",id:"key-features-still-to-come-in-openc3-cosmos-5x",level:2},{value:"OpenC3 COSMOS 6.0 (Summer 2024)",id:"openc3-cosmos-60-summer-2024",level:2},{value:"OpenC3 COSMOS 7.0 (Summer 2025)",id:"openc3-cosmos-70-summer-2025",level:2},{value:"Near-term Quarterly Roadmap",id:"near-term-quarterly-roadmap",level:2}];function d(e){const s={a:"a",h2:"h2",input:"input",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h2,{id:"key-features-still-to-come-in-openc3-cosmos-5x",children:"Key Features Still to Come in OpenC3 COSMOS 5.x:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Command Authority (Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Critical Commanding (Two Operators - Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Log Message Extractor Tool (Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","System Health Tool (Enterprise)"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"openc3-cosmos-60-summer-2024",children:"OpenC3 COSMOS 6.0 (Summer 2024)"}),"\n",(0,n.jsx)(s.p,{children:"Core Features:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",checked:!0,disabled:!0})," ","Python Support"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Upgrade Tools to Vue 3 / Vuetify 3"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Plugin App Store"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Functionality For 6.1+:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Standardized Mission Planning Interface (aka Command Load Generator (CLG))"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","libCSP Interface"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Standardized Interfaces for All Common Message Buses"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"openc3-cosmos-70-summer-2025",children:"OpenC3 COSMOS 7.0 (Summer 2025)"}),"\n",(0,n.jsx)(s.p,{children:"Core Features:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Super Bridge - This will enable SaaS COSMOS and provide a secure method to communicate from a cloud server to an intranet for hardware control"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"near-term-quarterly-roadmap",children:"Near-term Quarterly Roadmap"}),"\n",(0,n.jsx)(s.p,{children:"Our near-term product roadmap linking to specific tickets is a Github Project found at the link below."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/orgs/openc3/projects/2/views/1",children:"Roadmap"})}),"\n",(0,n.jsx)(s.p,{children:"If you would like to commit feature ideas for our roadmap, please do so with normal Github issues at the main repo."})]})}function m(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>o});var n=t(4041);const i={},a=n.createContext(i);function o(e){const s=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}}}]);

data/tools/staticdocs/assets/js/75373ac0.6a0a4fa2.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5992],{7336:o=>{o.exports=JSON.parse('{"title":"Tools","slug":"/tools","permalink":"/tools/staticdocs/docs/tools","navigation":{"previous":{"title":"SSL-TLS","permalink":"/tools/staticdocs/docs/configuration/ssl-tls"},"next":{"title":"Autonomic (Enterprise)","permalink":"/tools/staticdocs/docs/tools/autonomic"}}}')}}]);

data/tools/staticdocs/assets/js/75e64983.e31793e1.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7388],{284:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=n(1085),i=n(1184);const o={sidebar_position:4,title:"Upgrading"},a=void 0,r={id:"getting-started/upgrading",title:"Upgrading",description:"COSMOS Upgrades",source:"@site/docs/getting-started/upgrading.md",sourceDirName:"getting-started",slug:"/getting-started/upgrading",permalink:"/tools/staticdocs/docs/getting-started/upgrading",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Upgrading"},sidebar:"defaultSidebar",previous:{title:"Code Generators",permalink:"/tools/staticdocs/docs/getting-started/generators"},next:{title:"Key Concepts",permalink:"/tools/staticdocs/docs/getting-started/key_concepts"}},c={},l=[{value:"COSMOS Upgrades",id:"cosmos-upgrades",level:3},{value:"Migrating From COSMOS 4 to COSMOS 5",id:"migrating-from-cosmos-4-to-cosmos-5",level:3}];function d(e){const t={a:"a",code:"code",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h3,{id:"cosmos-upgrades",children:"COSMOS Upgrades"}),"\n",(0,s.jsx)(t.p,{children:"COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release."}),"\n",(0,s.jsx)(t.p,{children:"This example assumes an existing COSMOS project at C:\\cosmos-project."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Stop the current COSMOS application"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat stop\n"})}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Change the release in the .env file to the desired release"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-batch",children:"OPENC3_TAG=5.1.1\n"})}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Run the new COSMOS application"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat run\n"})}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h3,{id:"migrating-from-cosmos-4-to-cosmos-5",children:"Migrating From COSMOS 4 to COSMOS 5"}),"\n",(0,s.jsxs)(t.p,{children:["COSMOS 5 is a new architecture and treats targets as independent ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins",children:"plugins"}),". Thus the primary effort in porting from COSMOS 4 to COSMOS 5 is converting targets to plugins. We recommend creating plugins for each independent target (with its own interface) but targets which share an interface will need to be part of the same plugin. The reason for independent plugins is it allows the plugin to be versioned separately and more easily shared outside your specific project. If you have very project specific targets (e.g. custom hardware) those can potentially be combined for ease of deployment."]}),"\n",(0,s.jsx)(t.p,{children:"COSMOS 5 includes a migration tool for converting an existing COSMOS 4 configuration into a COSMOS 5 plugin. This example assumes an existing COSMOS 4 configuration at C:\\COSMOS and a new COSMOS 5 installation at C:\\cosmos-project. Linux users can adjust paths and change from .bat to .sh to follow along."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Change to the existing COSMOS 4 configuration directory. You should see the config, lib, procedures, outputs directory. You can then run the migration tool by specifying the absolute path to the COSMOS 5 installation."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate -a demo\n"})}),"\n",(0,s.jsx)(t.p,{children:"This creates a new COSMOS 5 plugin called openc3-cosmos-demo with a target named DEMO containing the existing lib and procedures files as well as all the existing targets."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate demo-part INST\n"})}),"\n",(0,s.jsx)(t.p,{children:"This would create a new COSMOS 5 plugin called openc3-cosmos-demo-part with a target named DEMO_PART containing the existing lib and procedures files as well as the INST target (but no others)."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Open the new COSMOS 5 plugin and ensure the ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#plugintxt-configuration-file",children:"plugin.txt"})," file is correctly configured. The migration tool doesn't create VARIABLEs or MICROSERVICEs or handle target substitution so those features will have to added manually."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Follow the ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/getting-started/gettingstarted#building-your-plugin",children:"building your plugin"})," part of the Getting Started tutorial to build your new plugin and upload it to COSMOS 5."]}),"\n"]}),"\n"]})]})}function g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1184:(e,t,n)=>{n.d(t,{R:()=>a});var s=n(4041);const i={},o=s.createContext(i);function a(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}}}]);

data/tools/staticdocs/assets/js/7918.25ec42db.js DELETED Viewed

@@ -1 +0,0 @@

- (self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7918],{1167:(e,n,t)=>{"use strict";t.d(n,{A:()=>E});var s=t(4041),o=t(1085);function c(e){const{mdxAdmonitionTitle:n,rest:t}=function(e){const n=s.Children.toArray(e),t=n.find((e=>s.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),c=n.filter((e=>e!==t)),a=t?.props.children;return{mdxAdmonitionTitle:a,rest:c.length>0?(0,o.jsx)(o.Fragment,{children:c}):null}}(e.children),c=e.title??n;return{...e,...c&&{title:c},children:t}}var a=t(4357),i=t(9082),r=t(7473);const l={admonition:"admonition_IZjC",admonitionHeading:"admonitionHeading_uVvU",admonitionIcon:"admonitionIcon_HiR3",admonitionContent:"admonitionContent_bl22"};function d(e){let{type:n,className:t,children:s}=e;return(0,o.jsx)("div",{className:(0,a.A)(r.G.common.admonition,r.G.common.admonitionType(n),l.admonition,t),children:s})}function u(e){let{icon:n,title:t}=e;return(0,o.jsxs)("div",{className:l.admonitionHeading,children:[(0,o.jsx)("span",{className:l.admonitionIcon,children:n}),t]})}function m(e){let{children:n}=e;return n?(0,o.jsx)("div",{className:l.admonitionContent,children:n}):null}function h(e){const{type:n,icon:t,title:s,children:c,className:a}=e;return(0,o.jsxs)(d,{type:n,className:a,children:[(0,o.jsx)(u,{title:s,icon:t}),(0,o.jsx)(m,{children:c})]})}function f(e){return(0,o.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})})}const p={icon:(0,o.jsx)(f,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)",children:"note"})};function g(e){return(0,o.jsx)(h,{...p,...e,className:(0,a.A)("alert alert--secondary",e.className),children:e.children})}function x(e){return(0,o.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})})}const v={icon:(0,o.jsx)(x,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)",children:"tip"})};function b(e){return(0,o.jsx)(h,{...v,...e,className:(0,a.A)("alert alert--success",e.className),children:e.children})}function j(e){return(0,o.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})})}const N={icon:(0,o.jsx)(j,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)",children:"info"})};function C(e){return(0,o.jsx)(h,{...N,...e,className:(0,a.A)("alert alert--info",e.className),children:e.children})}function k(e){return(0,o.jsx)("svg",{viewBox:"0 0 16 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})})}const y={icon:(0,o.jsx)(k,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.warning",description:"The default label used for the Warning admonition (:::warning)",children:"warning"})};function A(e){return(0,o.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})})}const B={icon:(0,o.jsx)(A,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)",children:"danger"})};const L={icon:(0,o.jsx)(k,{}),title:(0,o.jsx)(i.A,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)",children:"caution"})};const w={...{note:g,tip:b,info:C,warning:function(e){return(0,o.jsx)(h,{...y,...e,className:(0,a.A)("alert alert--warning",e.className),children:e.children})},danger:function(e){return(0,o.jsx)(h,{...B,...e,className:(0,a.A)("alert alert--danger",e.className),children:e.children})}},...{secondary:e=>(0,o.jsx)(g,{title:"secondary",...e}),important:e=>(0,o.jsx)(C,{title:"important",...e}),success:e=>(0,o.jsx)(b,{title:"success",...e}),caution:function(e){return(0,o.jsx)(h,{...L,...e,className:(0,a.A)("alert alert--warning",e.className),children:e.children})}}};function E(e){const n=c(e),t=(s=n.type,w[s]||(console.warn(`No admonition component found for admonition type "${s}". Using Info as fallback.`),w.info));var s;return(0,o.jsx)(t,{...n})}},7859:(e,n,t)=>{"use strict";t.d(n,{A:()=>re});var s=t(4041);const o={},c=s.createContext(o);function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:function(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}(e.components),s.createElement(c.Provider,{value:n},e.children)}var i=t(9058),r=t(213),l=t(4357),d=t(2727),u=t(2520);function m(){const{prism:e}=(0,u.p)(),{colorMode:n}=(0,d.G)(),t=e.theme,s=e.darkTheme||t;return"dark"===n?s:t}var h=t(7473),f=t(1431),p=t.n(f);const g=/title=(?<quote>["'])(?<title>.*?)\1/,x=/\{(?<range>[\d,-]+)\}/,v={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},b={...v,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\$\\*",end:"\\*\$"},cobol:{start:"\\*>",end:""}},j=Object.keys(v);function N(e,n){const t=e.map((e=>{const{start:t,end:s}=b[e];return`(?:${t}\\s*(${n.flatMap((e=>[e.line,e.block?.start,e.block?.end].filter(Boolean))).join("|")})\\s*${s})`})).join("|");return new RegExp(`^\\s*(?:${t})\\s*$`)}function C(e,n){let t=e.replace(/\n$/,"");const{language:s,magicComments:o,metastring:c}=n;if(c&&x.test(c)){const e=c.match(x).groups.range;if(0===o.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${c}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const n=o[0].className,s=p()(e).filter((e=>e>0)).map((e=>[e-1,[n]]));return{lineClassNames:Object.fromEntries(s),code:t}}if(void 0===s)return{lineClassNames:{},code:t};const a=function(e,n){switch(e){case"js":case"javascript":case"ts":case"typescript":return N(["js","jsBlock"],n);case"jsx":case"tsx":return N(["js","jsBlock","jsx"],n);case"html":return N(["js","jsBlock","html"],n);case"python":case"py":case"bash":return N(["bash"],n);case"markdown":case"md":return N(["html","jsx","bash"],n);case"tex":case"latex":case"matlab":return N(["tex"],n);case"lua":case"haskell":case"sql":return N(["lua"],n);case"wasm":return N(["wasm"],n);case"vb":case"vbnet":case"vba":case"visual-basic":return N(["vb","rem"],n);case"batch":return N(["rem"],n);case"basic":return N(["rem","f90"],n);case"fsharp":return N(["js","ml"],n);case"ocaml":case"sml":return N(["ml"],n);case"fortran":return N(["f90"],n);case"cobol":return N(["cobol"],n);default:return N(j,n)}}(s,o),i=t.split("\n"),r=Object.fromEntries(o.map((e=>[e.className,{start:0,range:""}]))),l=Object.fromEntries(o.filter((e=>e.line)).map((e=>{let{className:n,line:t}=e;return[t,n]}))),d=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:n,block:t}=e;return[t.start,n]}))),u=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:n,block:t}=e;return[t.end,n]})));for(let h=0;h<i.length;){const e=i[h].match(a);if(!e){h+=1;continue}const n=e.slice(1).find((e=>void 0!==e));l[n]?r[l[n]].range+=`${h},`:d[n]?r[d[n]].start=h:u[n]&&(r[u[n]].range+=`${r[u[n]].start}-${h-1},`),i.splice(h,1)}t=i.join("\n");const m={};return Object.entries(r).forEach((e=>{let[n,{range:t}]=e;p()(t).forEach((e=>{m[e]??=[],m[e].push(n)}))})),{lineClassNames:m,code:t}}const k={codeBlockContainer:"codeBlockContainer_ZGJx"};var y=t(1085);function A(e){let{as:n,...t}=e;const s=function(e){const n={color:"--prism-color",backgroundColor:"--prism-background-color"},t={};return Object.entries(e.plain).forEach((e=>{let[s,o]=e;const c=n[s];c&&"string"==typeof o&&(t[c]=o)})),t}(m());return(0,y.jsx)(n,{...t,style:s,className:(0,l.A)(t.className,k.codeBlockContainer,h.G.common.codeBlock)})}const B={codeBlockContent:"codeBlockContent_qZBB",codeBlockTitle:"codeBlockTitle_zAEH",codeBlock:"codeBlock_TAPP",codeBlockStandalone:"codeBlockStandalone_K9VJ",codeBlockLines:"codeBlockLines_AdAo",codeBlockLinesWithNumbering:"codeBlockLinesWithNumbering_p5De",buttonGroup:"buttonGroup_TNwR"};function L(e){let{children:n,className:t}=e;return(0,y.jsx)(A,{as:"pre",tabIndex:0,className:(0,l.A)(B.codeBlockStandalone,"thin-scrollbar",t),children:(0,y.jsx)("code",{className:B.codeBlockLines,children:n})})}var w=t(1786);const E={attributes:!0,characterData:!0,childList:!0,subtree:!0};function H(e,n){const[t,o]=(0,s.useState)(),c=(0,s.useCallback)((()=>{o(e.current?.closest("[role=tabpanel][hidden]"))}),[e,o]);(0,s.useEffect)((()=>{c()}),[c]),function(e,n,t){void 0===t&&(t=E);const o=(0,w._q)(n),c=(0,w.Be)(t);(0,s.useEffect)((()=>{const n=new MutationObserver(o);return e&&n.observe(e,c),()=>n.disconnect()}),[e,o,c])}(t,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(n(),c())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}var _=t(4370);const T={codeLine:"codeLine_DPDv",codeLineNumber:"codeLineNumber_YxQB",codeLineContent:"codeLineContent_SOIp"};function S(e){let{line:n,classNames:t,showLineNumbers:s,getLineProps:o,getTokenProps:c}=e;1===n.length&&"\n"===n[0].content&&(n[0].content="");const a=o({line:n,className:(0,l.A)(t,s&&T.codeLine)}),i=n.map(((e,n)=>(0,y.jsx)("span",{...c({token:e,key:n})},n)));return(0,y.jsxs)("span",{...a,children:[s?(0,y.jsxs)(y.Fragment,{children:[(0,y.jsx)("span",{className:T.codeLineNumber}),(0,y.jsx)("span",{className:T.codeLineContent,children:i})]}):i,(0,y.jsx)("br",{})]})}var I=t(9082);function M(e){return(0,y.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,y.jsx)("path",{fill:"currentColor",d:"M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"})})}function z(e){return(0,y.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,y.jsx)("path",{fill:"currentColor",d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"})})}const R={copyButtonCopied:"copyButtonCopied_Mzdr",copyButtonIcons:"copyButtonIcons_MVhB",copyButtonIcon:"copyButtonIcon_yxgH",copyButtonSuccessIcon:"copyButtonSuccessIcon_QJLJ"};function O(e){let{code:n,className:t}=e;const[o,c]=(0,s.useState)(!1),a=(0,s.useRef)(void 0),i=(0,s.useCallback)((()=>{!function(e,n){let{target:t=document.body}=void 0===n?{}:n;if("string"!=typeof e)throw new TypeError(`Expected parameter \`text\` to be a \`string\`, got \`${typeof e}\`.`);const s=document.createElement("textarea"),o=document.activeElement;s.value=e,s.setAttribute("readonly",""),s.style.contain="strict",s.style.position="absolute",s.style.left="-9999px",s.style.fontSize="12pt";const c=document.getSelection(),a=c.rangeCount>0&&c.getRangeAt(0);t.append(s),s.select(),s.selectionStart=0,s.selectionEnd=e.length;let i=!1;try{i=document.execCommand("copy")}catch{}s.remove(),a&&(c.removeAllRanges(),c.addRange(a)),o&&o.focus()}(n),c(!0),a.current=window.setTimeout((()=>{c(!1)}),1e3)}),[n]);return(0,s.useEffect)((()=>()=>window.clearTimeout(a.current)),[]),(0,y.jsx)("button",{type:"button","aria-label":o?(0,I.T)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,I.T)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,I.T)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,l.A)("clean-btn",t,R.copyButton,o&&R.copyButtonCopied),onClick:i,children:(0,y.jsxs)("span",{className:R.copyButtonIcons,"aria-hidden":"true",children:[(0,y.jsx)(M,{className:R.copyButtonIcon}),(0,y.jsx)(z,{className:R.copyButtonSuccessIcon})]})})}function V(e){return(0,y.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,y.jsx)("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})})}const $={wordWrapButtonIcon:"wordWrapButtonIcon_SMj9",wordWrapButtonEnabled:"wordWrapButtonEnabled_vR9E"};function W(e){let{className:n,onClick:t,isEnabled:s}=e;const o=(0,I.T)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return(0,y.jsx)("button",{type:"button",onClick:t,className:(0,l.A)("clean-btn",n,s&&$.wordWrapButtonEnabled),"aria-label":o,title:o,children:(0,y.jsx)(V,{className:$.wordWrapButtonIcon,"aria-hidden":"true"})})}function D(e){let{children:n,className:t="",metastring:o,title:c,showLineNumbers:a,language:i}=e;const{prism:{defaultLanguage:r,magicComments:d}}=(0,u.p)(),h=function(e){return e?.toLowerCase()}(i??function(e){const n=e.split(" ").find((e=>e.startsWith("language-")));return n?.replace(/language-/,"")}(t)??r),f=m(),p=function(){const[e,n]=(0,s.useState)(!1),[t,o]=(0,s.useState)(!1),c=(0,s.useRef)(null),a=(0,s.useCallback)((()=>{const t=c.current.querySelector("code");e?t.removeAttribute("style"):(t.style.whiteSpace="pre-wrap",t.style.overflowWrap="anywhere"),n((e=>!e))}),[c,e]),i=(0,s.useCallback)((()=>{const{scrollWidth:e,clientWidth:n}=c.current,t=e>n||c.current.querySelector("code").hasAttribute("style");o(t)}),[c]);return H(c,i),(0,s.useEffect)((()=>{i()}),[e,i]),(0,s.useEffect)((()=>(window.addEventListener("resize",i,{passive:!0}),()=>{window.removeEventListener("resize",i)})),[i]),{codeBlockRef:c,isEnabled:e,isCodeScrollable:t,toggle:a}}(),x=function(e){return e?.match(g)?.groups.title??""}(o)||c,{lineClassNames:v,code:b}=C(n,{metastring:o,language:h,magicComments:d}),j=a??function(e){return Boolean(e?.includes("showLineNumbers"))}(o);return(0,y.jsxs)(A,{as:"div",className:(0,l.A)(t,h&&!t.includes(`language-${h}`)&&`language-${h}`),children:[x&&(0,y.jsx)("div",{className:B.codeBlockTitle,children:x}),(0,y.jsxs)("div",{className:B.codeBlockContent,children:[(0,y.jsx)(_.f4,{theme:f,code:b,language:h??"text",children:e=>{let{className:n,style:t,tokens:s,getLineProps:o,getTokenProps:c}=e;return(0,y.jsx)("pre",{tabIndex:0,ref:p.codeBlockRef,className:(0,l.A)(n,B.codeBlock,"thin-scrollbar"),style:t,children:(0,y.jsx)("code",{className:(0,l.A)(B.codeBlockLines,j&&B.codeBlockLinesWithNumbering),children:s.map(((e,n)=>(0,y.jsx)(S,{line:e,getLineProps:o,getTokenProps:c,classNames:v[n],showLineNumbers:j},n)))})})}}),(0,y.jsxs)("div",{className:B.buttonGroup,children:[(p.isEnabled||p.isCodeScrollable)&&(0,y.jsx)(W,{className:B.codeButton,onClick:()=>p.toggle(),isEnabled:p.isEnabled}),(0,y.jsx)(O,{className:B.codeButton,code:b})]})]})]})}function P(e){let{children:n,...t}=e;const o=(0,r.A)(),c=function(e){return s.Children.toArray(e).some((e=>(0,s.isValidElement)(e)))?e:Array.isArray(e)?e.join(""):e}(n),a="string"==typeof c?D:L;return(0,y.jsx)(a,{...t,children:c},String(o))}function G(e){return(0,y.jsx)("code",{...e})}var q=t(2436);var F=t(6476);const J={details:"details_B4FW",isBrowser:"isBrowser_Cof9",collapsibleContent:"collapsibleContent_VYua"};function Z(e){return!!e&&("SUMMARY"===e.tagName||Z(e.parentElement))}function U(e,n){return!!e&&(e===n||U(e.parentElement,n))}function Y(e){let{summary:n,children:t,...o}=e;const c=(0,r.A)(),a=(0,s.useRef)(null),{collapsed:i,setCollapsed:d}=(0,F.u)({initialState:!o.open}),[u,m]=(0,s.useState)(o.open),h=s.isValidElement(n)?n:(0,y.jsx)("summary",{children:n??"Details"});return(0,y.jsxs)("details",{...o,ref:a,open:u,"data-collapsed":i,className:(0,l.A)(J.details,c&&J.isBrowser,o.className),onMouseDown:e=>{Z(e.target)&&e.detail>1&&e.preventDefault()},onClick:e=>{e.stopPropagation();const n=e.target;Z(n)&&U(n,a.current)&&(e.preventDefault(),i?(d(!1),m(!0)):d(!0))},children:[h,(0,y.jsx)(F.N,{lazy:!1,collapsed:i,disableSSRStyle:!0,onCollapseTransitionEnd:e=>{d(e),m(!e)},children:(0,y.jsx)("div",{className:J.collapsibleContent,children:t})})]})}const Q={details:"details_SZgV"},K="alert alert--info";function X(e){let{...n}=e;return(0,y.jsx)(Y,{...n,className:(0,l.A)(K,Q.details,n.className)})}function ee(e){const n=s.Children.toArray(e.children),t=n.find((e=>s.isValidElement(e)&&"summary"===e.type)),o=(0,y.jsx)(y.Fragment,{children:n.filter((e=>e!==t))});return(0,y.jsx)(X,{...e,summary:t,children:o})}var ne=t(4775);function te(e){return(0,y.jsx)(ne.A,{...e})}const se={containsTaskList:"containsTaskList__YnT"};function oe(e){if(void 0!==e)return(0,l.A)(e,e?.includes("contains-task-list")&&se.containsTaskList)}const ce={img:"img__Ss2"};var ae=t(1167);const ie={Head:i.A,details:ee,Details:ee,code:function(e){return function(e){return void 0!==e.children&&s.Children.toArray(e.children).every((e=>"string"==typeof e&&!e.includes("\n")))}(e)?(0,y.jsx)(G,{...e}):(0,y.jsx)(P,{...e})},a:function(e){return(0,y.jsx)(q.A,{...e})},pre:function(e){return(0,y.jsx)(y.Fragment,{children:e.children})},ul:function(e){return(0,y.jsx)("ul",{...e,className:oe(e.className)})},img:function(e){return(0,y.jsx)("img",{loading:"lazy",...e,className:(n=e.className,(0,l.A)(n,ce.img))});var n},h1:e=>(0,y.jsx)(te,{as:"h1",...e}),h2:e=>(0,y.jsx)(te,{as:"h2",...e}),h3:e=>(0,y.jsx)(te,{as:"h3",...e}),h4:e=>(0,y.jsx)(te,{as:"h4",...e}),h5:e=>(0,y.jsx)(te,{as:"h5",...e}),h6:e=>(0,y.jsx)(te,{as:"h6",...e}),admonition:ae.A,mermaid:()=>null};function re(e){let{children:n}=e;return(0,y.jsx)(a,{components:ie,children:n})}},7703:(e,n,t)=>{"use strict";t.d(n,{A:()=>l});t(4041);var s=t(4357),o=t(9969);const c={tableOfContents:"tableOfContents_TN1Q",docItemContainer:"docItemContainer_JtJJ"};var a=t(1085);const i="table-of-contents__link toc-highlight",r="table-of-contents__link--active";function l(e){let{className:n,...t}=e;return(0,a.jsx)("div",{className:(0,s.A)(c.tableOfContents,"thin-scrollbar",n),children:(0,a.jsx)(o.A,{...t,linkClassName:i,linkActiveClassName:r})})}},9969:(e,n,t)=>{"use strict";t.d(n,{A:()=>p});var s=t(4041),o=t(2520);function c(e){const n=e.map((e=>({...e,parentIndex:-1,children:[]}))),t=Array(7).fill(-1);n.forEach(((e,n)=>{const s=t.slice(2,e.level);e.parentIndex=Math.max(...s),t[e.level]=n}));const s=[];return n.forEach((e=>{const{parentIndex:t,...o}=e;t>=0?n[t].children.push(o):s.push(o)})),s}function a(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:s}=e;return n.flatMap((e=>{const n=a({toc:e.children,minHeadingLevel:t,maxHeadingLevel:s});return function(e){return e.level>=t&&e.level<=s}(e)?[{...e,children:n}]:n}))}function i(e){const n=e.getBoundingClientRect();return n.top===n.bottom?i(e.parentNode):n}function r(e,n){let{anchorTopOffset:t}=n;const s=e.find((e=>i(e).top>=t));if(s){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(i(s))?s:e[e.indexOf(s)-1]??null}return e[e.length-1]??null}function l(){const e=(0,s.useRef)(0),{navbar:{hideOnScroll:n}}=(0,o.p)();return(0,s.useEffect)((()=>{e.current=n?0:document.querySelector(".navbar").clientHeight}),[n]),e}function d(e){const n=(0,s.useRef)(void 0),t=l();(0,s.useEffect)((()=>{if(!e)return()=>{};const{linkClassName:s,linkActiveClassName:o,minHeadingLevel:c,maxHeadingLevel:a}=e;function i(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(s),i=function(e){let{minHeadingLevel:n,maxHeadingLevel:t}=e;const s=[];for(let o=n;o<=t;o+=1)s.push(`h${o}.anchor`);return Array.from(document.querySelectorAll(s.join()))}({minHeadingLevel:c,maxHeadingLevel:a}),l=r(i,{anchorTopOffset:t.current}),d=e.find((e=>l&&l.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e)));e.forEach((e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(o),e.classList.add(o),n.current=e):e.classList.remove(o)}(e,e===d)}))}return document.addEventListener("scroll",i),document.addEventListener("resize",i),i(),()=>{document.removeEventListener("scroll",i),document.removeEventListener("resize",i)}}),[e,t])}var u=t(2436),m=t(1085);function h(e){let{toc:n,className:t,linkClassName:s,isChild:o}=e;return n.length?(0,m.jsx)("ul",{className:o?void 0:t,children:n.map((e=>(0,m.jsxs)("li",{children:[(0,m.jsx)(u.A,{to:`#${e.id}`,className:s??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,m.jsx)(h,{isChild:!0,toc:e.children,className:t,linkClassName:s})]},e.id)))}):null}const f=s.memo(h);function p(e){let{toc:n,className:t="table-of-contents table-of-contents__left-border",linkClassName:i="table-of-contents__link",linkActiveClassName:r,minHeadingLevel:l,maxHeadingLevel:u,...h}=e;const p=(0,o.p)(),g=l??p.tableOfContents.minHeadingLevel,x=u??p.tableOfContents.maxHeadingLevel,v=function(e){let{toc:n,minHeadingLevel:t,maxHeadingLevel:o}=e;return(0,s.useMemo)((()=>a({toc:c(n),minHeadingLevel:t,maxHeadingLevel:o})),[n,t,o])}({toc:n,minHeadingLevel:g,maxHeadingLevel:x});return d((0,s.useMemo)((()=>{if(i&&r)return{linkClassName:i,linkActiveClassName:r,minHeadingLevel:g,maxHeadingLevel:x}}),[i,r,g,x])),(0,m.jsx)(f,{toc:v,className:t,linkClassName:i,...h})}},7262:(e,n,t)=>{"use strict";t.d(n,{A:()=>h});t(4041);var s=t(4357),o=t(9082),c=t(9058),a=t(1085);function i(){return(0,a.jsx)(o.A,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function r(){return(0,a.jsx)(o.A,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function l(){return(0,a.jsx)(c.A,{children:(0,a.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}var d=t(7473),u=t(1167);function m(e){let{className:n}=e;return(0,a.jsx)(u.A,{type:"caution",title:(0,a.jsx)(i,{}),className:(0,s.A)(n,d.G.common.unlistedBanner),children:(0,a.jsx)(r,{})})}function h(e){return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(l,{}),(0,a.jsx)(m,{...e})]})}},1431:(e,n)=>{function t(e){let n,t=[];for(let s of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(s))t.push(parseInt(s,10));else if(n=s.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,s,o,c]=n;if(s&&c){s=parseInt(s),c=parseInt(c);const e=s<c?1:-1;"-"!==o&&".."!==o&&"\u2025"!==o||(c+=e);for(let n=s;n!==c;n+=e)t.push(n)}}return t}n.default=t,e.exports=t}}]);

data/tools/staticdocs/assets/js/89e76475.de702714.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7660],{734:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(1085),n=t(1184);const i={title:"Bucket Explorer"},l=void 0,r={id:"tools/bucket-explorer",title:"Bucket Explorer",description:"Introduction",source:"@site/docs/tools/bucket-explorer.md",sourceDirName:"tools",slug:"/tools/bucket-explorer",permalink:"/tools/staticdocs/docs/tools/bucket-explorer",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/bucket-explorer.md",tags:[],version:"current",frontMatter:{title:"Bucket Explorer"},sidebar:"defaultSidebar",previous:{title:"Autonomic (Enterprise)",permalink:"/tools/staticdocs/docs/tools/autonomic"},next:{title:"Calendar (Enterprise)",permalink:"/tools/staticdocs/docs/tools/calendar"}},c={},d=[{value:"Introduction",id:"introduction",level:2},{value:"Browsing Files",id:"browsing-files",level:2},{value:"Upload",id:"upload",level:3},{value:"Download",id:"download",level:3},{value:"Delete",id:"delete",level:3}];function a(e){const o={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(o.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsx)(o.p,{children:"Bucket Explorer is a file browser to the COSMOS backend bucket storage system. It allows you to view files in an intuitive file browser hierarchy and download them. Bucket Explorer works both with local installations of COSMOS as well as cloud deployments which utilize cloud storage such as AWS S3 and GCP Cloud Storage."}),"\n",(0,s.jsx)(o.p,{children:(0,s.jsx)(o.img,{alt:"Bucket Explorer",src:t(6278).A+"",width:"1271",height:"543"})}),"\n",(0,s.jsx)(o.h2,{id:"browsing-files",children:"Browsing Files"}),"\n",(0,s.jsxs)(o.p,{children:["At the top are the three standard COSMOS buckets: ",(0,s.jsx)(o.code,{children:"config"}),", ",(0,s.jsx)(o.code,{children:"logs"}),", and ",(0,s.jsx)(o.code,{children:"tools"}),". Each bucket contains top level folders named after the scope. In the Open Source edition the only scope is ",(0,s.jsx)(o.code,{children:"DEFAULT"}),". The ",(0,s.jsx)(o.code,{children:"config"})," bucket holds the COSMOS configuration which is populated as plugins are installed. The ",(0,s.jsx)(o.code,{children:"logs"})," bucket holds the COSMOS logs which are generated by the various COSMOS microservices (See ",(0,s.jsx)(o.a,{href:"/tools/staticdocs/docs/guides/logging",children:"Logging"})," for more info). These logs are gzipped to save storage space. The ",(0,s.jsx)(o.code,{children:"tools"})," bucket holds the source code for the built-in COSMOS tools as well as user created tools installed as plugins. Note that the search box only searches the current screen worth of files, e.g. it does not search the entire bucket."]}),"\n",(0,s.jsx)(o.admonition,{title:"Tools as Static Website",type:"note",children:(0,s.jsx)(o.p,{children:"Using bucket storage allows COSMOS to directly serve the tools as a static website and thus it must be a public bucket in cloud technology like S3"})}),"\n",(0,s.jsx)(o.h3,{id:"upload",children:"Upload"}),"\n",(0,s.jsxs)(o.p,{children:["Click the Upload icon to bring up a file browser to select a file to upload into the current bucket and path. Note that in ",(0,s.jsx)(o.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," you can only upload files to the config/DEFAULT/targets_modified folder unless you're an Admin."]}),"\n",(0,s.jsx)(o.h3,{id:"download",children:"Download"}),"\n",(0,s.jsx)(o.p,{children:"Click the Download icon to download any of the individual files from any bucket and path."}),"\n",(0,s.jsx)(o.h3,{id:"delete",children:"Delete"}),"\n",(0,s.jsxs)(o.p,{children:["Click the Trash icon to delete an individual file. Note that in ",(0,s.jsx)(o.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," you can only delete files in the config/DEFAULT/targets_modified folder unless you're an Admin."]})]})}function h(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,s.jsx)(o,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},6278:(e,o,t)=>{t.d(o,{A:()=>s});const s=t.p+"assets/images/bucket_explorer-ba88a20121198c3441a6af5302ab1a6ad62a171661037e9e3bfd312ca8bdb5ef.png"},1184:(e,o,t)=>{t.d(o,{R:()=>l});var s=t(4041);const n={},i=s.createContext(n);function l(e){const o=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}}}]);

data/tools/staticdocs/assets/js/9424f0b3.b24d0393.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4909],{3902:(e,s,d)=>{d.r(s),d.d(s,{assets:()=>h,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=d(1085),n=d(1184);const t={sidebar_position:9,title:"Screens"},i=void 0,l={id:"configuration/telemetry-screens",title:"Screens",description:"This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.",source:"@site/docs/configuration/telemetry-screens.md",sourceDirName:"configuration",slug:"/configuration/telemetry-screens",permalink:"/tools/staticdocs/docs/configuration/telemetry-screens",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry-screens.md",tags:[],version:"current",sidebarPosition:9,frontMatter:{sidebar_position:9,title:"Screens"},sidebar:"defaultSidebar",previous:{title:"Tables",permalink:"/tools/staticdocs/docs/configuration/table"},next:{title:"SSL-TLS",permalink:"/tools/staticdocs/docs/configuration/ssl-tls"}},h={},c=[{value:"Definitions",id:"definitions",level:2},{value:"Telemetry Screen Definition Files",id:"telemetry-screen-definition-files",level:2},{value:"New Widgets",id:"new-widgets",level:2},{value:"SCREEN",id:"screen",level:2},{value:"END",id:"end",level:2},{value:"STALE_TIME",id:"stale_time",level:2},{value:"GLOBAL_SETTING",id:"global_setting",level:2},{value:"GLOBAL_SUBSETTING",id:"global_subsetting",level:2},{value:"SETTING",id:"setting",level:2},{value:"WIDTH",id:"width",level:3},{value:"HEIGHT",id:"height",level:3},{value:"MARGIN",id:"margin",level:3},{value:"PADDING",id:"padding",level:3},{value:"BACKCOLOR",id:"backcolor",level:3},{value:"TEXTCOLOR",id:"textcolor",level:3},{value:"BORDERCOLOR",id:"bordercolor",level:3},{value:"RAW",id:"raw",level:3},{value:"SUBSETTING",id:"subsetting",level:2},{value:"NAMED_WIDGET",id:"named_widget",level:2},{value:"Layout Widgets",id:"layout-widgets",level:2},{value:"VERTICAL",id:"vertical",level:3},{value:"VERTICALBOX",id:"verticalbox",level:3},{value:"HORIZONTAL",id:"horizontal",level:3},{value:"HORIZONTALBOX",id:"horizontalbox",level:3},{value:"MATRIXBYCOLUMNS",id:"matrixbycolumns",level:3},{value:"SCROLLWINDOW",id:"scrollwindow",level:3},{value:"TABBOOK",id:"tabbook",level:3},{value:"TABITEM",id:"tabitem",level:3},{value:"IFRAME",id:"iframe",level:3},{value:"Decoration Widgets",id:"decoration-widgets",level:2},{value:"LABEL",id:"label",level:3},{value:"HORIZONTALLINE",id:"horizontalline",level:3},{value:"SECTIONHEADER",id:"sectionheader",level:3},{value:"TITLE",id:"title",level:3},{value:"SPACER",id:"spacer",level:3},{value:"Telemetry Widgets",id:"telemetry-widgets",level:2},{value:"ARRAY",id:"array",level:3},{value:"BLOCK",id:"block",level:3},{value:"FORMATVALUE",id:"formatvalue",level:3},{value:"LABELLED",id:"labelled",level:3},{value:"LED_COLOR",id:"led_color",level:4},{value:"LABELPROGRESSBAR",id:"labelprogressbar",level:3},{value:"LABELVALUE",id:"labelvalue",level:3},{value:"LABELVALUEDESC",id:"labelvaluedesc",level:3},{value:"LABELVALUELIMITSBAR",id:"labelvaluelimitsbar",level:3},{value:"LABELVALUELIMITSCOLUMN",id:"labelvaluelimitscolumn",level:3},{value:"LABELVALUERANGEBAR",id:"labelvaluerangebar",level:3},{value:"LED",id:"led",level:3},{value:"LED_COLOR",id:"led_color-1",level:4},{value:"LIMITSBAR",id:"limitsbar",level:3},{value:"LIMITSCOLUMN",id:"limitscolumn",level:3},{value:"LIMITSCOLOR",id:"limitscolor",level:3},{value:"VALUELIMITSBAR",id:"valuelimitsbar",level:3},{value:"VALUELIMITSCOLUMN",id:"valuelimitscolumn",level:3},{value:"VALUERANGEBAR",id:"valuerangebar",level:3},{value:"LINEGRAPH",id:"linegraph",level:3},{value:"ITEM",id:"item",level:4},{value:"STARTTIME",id:"starttime",level:4},{value:"HISTORY",id:"history",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed",level:4},{value:"POINTSSAVED",id:"pointssaved",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed",level:4},{value:"SIZE",id:"size",level:4},{value:"SPARKLINE",id:"sparkline",level:3},{value:"ITEM",id:"item-1",level:4},{value:"STARTTIME",id:"starttime-1",level:4},{value:"HISTORY",id:"history-1",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed-1",level:4},{value:"POINTSSAVED",id:"pointssaved-1",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed-1",level:4},{value:"SIZE",id:"size-1",level:4},{value:"LABELSPARKLINE",id:"labelsparkline",level:3},{value:"ITEM",id:"item-2",level:4},{value:"STARTTIME",id:"starttime-2",level:4},{value:"HISTORY",id:"history-2",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed-2",level:4},{value:"POINTSSAVED",id:"pointssaved-2",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed-2",level:4},{value:"SIZE",id:"size-2",level:4},{value:"IMAGEVIEWER",id:"imageviewer",level:3},{value:"PROGRESSBAR",id:"progressbar",level:3},{value:"RANGEBAR",id:"rangebar",level:3},{value:"TEXTBOX",id:"textbox",level:3},{value:"VALUE",id:"value",level:3},{value:"Interactive Widgets",id:"interactive-widgets",level:2},{value:"BUTTON",id:"button",level:3},{value:"CHECKBUTTON",id:"checkbutton",level:3},{value:"COMBOBOX",id:"combobox",level:3},{value:"RADIOGROUP",id:"radiogroup",level:3},{value:"RADIOBUTTON",id:"radiobutton",level:3},{value:"TEXTFIELD",id:"textfield",level:3},{value:"Canvas Widgets",id:"canvas-widgets",level:2},{value:"CANVAS",id:"canvas",level:3},{value:"CANVASLABEL",id:"canvaslabel",level:3},{value:"CANVASLABELVALUE",id:"canvaslabelvalue",level:3},{value:"CANVASIMAGE",id:"canvasimage",level:3},{value:"SCREEN",id:"screen-1",level:4},{value:"CANVASIMAGEVALUE",id:"canvasimagevalue",level:3},{value:"IMAGE",id:"image",level:4},{value:"SCREEN",id:"screen-2",level:4},{value:"CANVASLINE",id:"canvasline",level:3},{value:"CANVASLINEVALUE",id:"canvaslinevalue",level:3},{value:"VALUE_EQ",id:"value_eq",level:4},{value:"CANVASDOT",id:"canvasdot",level:3},{value:"Example File",id:"example-file",level:2}];function a(e){const s={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.p,{children:"This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."}),"\n",(0,r.jsx)("div",{style:{clear:"both"}}),"\n",(0,r.jsx)(s.h2,{id:"definitions",children:"Definitions"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Definition"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget"}),(0,r.jsx)(s.td,{children:"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."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen"}),(0,r.jsx)(s.td,{children:"A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion."})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen Definition File"}),(0,r.jsx)(s.td,{children:"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."})]})]})]}),"\n",(0,r.jsx)(s.h2,{id:"telemetry-screen-definition-files",children:"Telemetry Screen Definition Files"}),"\n",(0,r.jsx)(s.p,{children:"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."}),"\n",(0,r.jsx)(s.h2,{id:"new-widgets",children:"New Widgets"}),"\n",(0,r.jsxs)(s.p,{children:["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 ",(0,r.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide."]}),"\n",(0,r.jsx)(s.h1,{id:"screen-keywords",children:"Screen Keywords"}),"\n",(0,r.jsx)(s.h2,{id:"screen",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Define a telemetry viewer screen"})}),"\n",(0,r.jsx)(s.p,{children:"The SCREEN keyword is the first keyword in any telemetry screen definition. It defines the name of the screen and parameters that affect the screen overall."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Polling Period"}),(0,r.jsx)(s.td,{children:"Number of seconds between screen updates"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 1.0 FIXED\n"})}),"\n",(0,r.jsx)(s.h2,{id:"end",children:"END"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Indicates the close of a layout widget"})}),"\n",(0,r.jsx)(s.p,{children:"All layout widgets must be closed to properly identify where they stop. For example, a VERTICALBOX keyword must be matched with an END keyword to indicate where the VERTICALBOX ends."}),"\n",(0,r.jsx)(s.h2,{id:"stale_time",children:"STALE_TIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.1.0)"}),(0,r.jsx)(s.strong,{children:"Values are marked stale if the packet time is more than Stale Time seconds in the past"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"value"}),(0,r.jsx)(s.td,{children:"Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale. The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions."}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"STALE_TIME 5 # Number of seconds to wait before marking data stale\n"})}),"\n",(0,r.jsx)(s.h2,{id:"global_setting",children:"GLOBAL_SETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget setting to all widgets of a certain type"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Class Name"}),(0,r.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK\n"})}),"\n",(0,r.jsx)(s.h2,{id:"global_subsetting",children:"GLOBAL_SUBSETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget subsetting to all widgets of a certain type"})}),"\n",(0,r.jsx)(s.p,{children:"Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Class Name"}),(0,r.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABELVALUE."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Subwidget Index"}),(0,r.jsx)(s.td,{children:"Index to the desired subwidget"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"# Set all text color to white for labelvaluelimitsbars\nGLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white\n"})}),"\n",(0,r.jsx)(s.h2,{id:"setting",children:"SETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget setting to the previously defined widget"})}),"\n",(0,r.jsx)(s.p,{children:"Settings allow for additional tweaks and options to be applied to widgets\nthat are not available in their parameters. These settings are all configured\nthrough the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords.\nSETTING and SUBSETTING applies only to the widget defined immediately before it.\nGLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets."}),"\n",(0,r.jsx)(s.p,{children:"Common wiget settings are defined here. Some widgets define their own\nunqiue settings which are documented under that specific widget."}),"\n",(0,r.jsx)(s.h3,{id:"width",children:"WIDTH"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget width"})}),"\n",(0,r.jsxs)(s.p,{children:["WIDTH supports ",(0,r.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING WIDTH 50\nLABEL "THIS IS A TEST"\n SETTING WIDTH 20em\n'})}),"\n",(0,r.jsx)(s.h3,{id:"height",children:"HEIGHT"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget height"})}),"\n",(0,r.jsxs)(s.p,{children:["HEIGHT supports ",(0,r.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING BACKCOLOR BLUE\n SETTING HEIGHT 50\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR GREY\n SETTING HEIGHT 2em\n'})}),"\n",(0,r.jsx)(s.h3,{id:"margin",children:"MARGIN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget margin"})}),"\n",(0,r.jsxs)(s.p,{children:["MARGIN supports ",(0,r.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Size"}),(0,r.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING BACKCOLOR BLUE\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR GREY\n SETTING MARGIN 10\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR GREEN\n'})}),"\n",(0,r.jsx)(s.h3,{id:"padding",children:"PADDING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget padding"})}),"\n",(0,r.jsxs)(s.p,{children:["PADDING supports ",(0,r.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Size"}),(0,r.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING BACKCOLOR BLUE\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR GREY\n SETTING PADDING 10\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR GREEN\n'})}),"\n",(0,r.jsx)(s.h3,{id:"backcolor",children:"BACKCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The BACKCOLOR setting sets the background color for a widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING BACKCOLOR red\nLABEL "THIS IS A TEST"\n SETTING BACKCOLOR 155 50 155\n'})}),"\n",(0,r.jsx)(s.h3,{id:"textcolor",children:"TEXTCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The TEXTCOLOR setting sets the text color for a widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n SETTING TEXTCOLOR red\nLABEL "THIS IS A TEST"\n SETTING TEXTCOLOR 155 50 155\n'})}),"\n",(0,r.jsx)(s.h3,{id:"bordercolor",children:"BORDERCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The BORDERCOLOR setting sets the border color for a layout widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'HORIZONTAL\n LABEL "Label 1"\nEND\nSETTING BORDERCOLOR red\nVERTICAL\n LABEL "Label 2"\nEND\nSETTING BORDERCOLOR 155 50 155\n'})}),"\n",(0,r.jsx)(s.h3,{id:"raw",children:"RAW"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Apply a raw CSS stylesheet key and value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Key"}),(0,r.jsx)(s.td,{children:"CSS key like font-size, max-width, etc"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"CSS Value"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "Label 1"\n SETTING RAW font-size 30px\n'})}),"\n",(0,r.jsx)(s.h2,{id:"subsetting",children:"SUBSETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget subsetting to the previously defined widget"})}),"\n",(0,r.jsx)(s.p,{children:"Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Subwidget Index"}),(0,r.jsx)(s.td,{children:"Index to the desired subwidget or 'ALL' to apply the setting to all the subwidgets of this composite widget."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VERTICALBOX\n LABELVALUE INST HEALTH_STATUS TEMP1\n SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue\n LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1\n SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green\nEND\n"})}),"\n",(0,r.jsx)(s.h2,{id:"named_widget",children:"NAMED_WIDGET"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Name a widget to allow access to it via the getNamedWidget method"})}),"\n",(0,r.jsx)(s.p,{children:"To programatically access parts of a telemetry screen you need to name the widget. This is useful when creating screens with buttons that read values from other widgets."}),"\n",(0,r.jsx)(s.admonition,{type:"warning",children:(0,r.jsx)(s.p,{children:"getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Name"}),(0,r.jsx)(s.td,{children:"The unique name applied to the following widget instance. Names must be unique per screen."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Type"}),(0,r.jsx)(s.td,{children:"One of the widget types listed in Widget Descriptions"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Parameters"}),(0,r.jsx)(s.td,{children:"The unique parameters for the given widget type"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'NAMED_WIDGET DURATION TEXTFIELD\nBUTTON "Push" "screen.getNamedWidget(\'DURATION\').text()"\n'})}),"\n",(0,r.jsx)(s.h2,{id:"layout-widgets",children:"Layout Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.p,{children:"Layout widgets are used to position other widgets on the screen. For example, the HORIZONTAL layout widget places the widgets it encapsulates horizontally on the screen."}),"\n",(0,r.jsx)(s.h3,{id:"vertical",children:"VERTICAL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically"})}),"\n",(0,r.jsx)(s.p,{children:"The screen defaults to a vertical layout, so if no layout widgets are specified, all widgets will be automatically placed within a VERTICAL layout widget. The VERTICAL widget sizes itself to fit its contents."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'VERTICAL 5px\n LABEL "TEST"\n LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"verticalbox",children:"VERTICALBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically inside a thin border"})}),"\n",(0,r.jsx)(s.p,{children:"The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Title"}),(0,r.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'VERTICALBOX Info\n LABEL "TEST"\n LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontal",children:"HORIZONTAL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally"})}),"\n",(0,r.jsx)(s.p,{children:"The HORIZONTAL widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'HORIZONTAL 100\n LABEL "TEST"\n LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontalbox",children:"HORIZONTALBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally inside a thin border"})}),"\n",(0,r.jsx)(s.p,{children:"The HORIZONTALBOX widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Title"}),(0,r.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'HORIZONTALBOX Info 10\n LABEL "TEST"\n LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"matrixbycolumns",children:"MATRIXBYCOLUMNS"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets into a table-like matrix"})}),"\n",(0,r.jsx)(s.p,{children:"The MATRIXBYCOLUMNS widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Columns"}),(0,r.jsx)(s.td,{children:"The number of columns to create"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'MATRIXBYCOLUMNS 3 10\n LABEL "COL 1"\n LABEL "COL 2"\n LABEL "COL 3"\n LABEL "100"\n LABEL "200"\n LABEL "300"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"scrollwindow",children:"SCROLLWINDOW"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets inside of it into a scrollable area"})}),"\n",(0,r.jsx)(s.p,{children:"The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Maximum height of the scroll window in pixels (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'SCROLLWINDOW 100 10\n VERTICAL\n LABEL "100"\n LABEL "200"\n LABEL "300"\n LABEL "400"\n LABEL "500"\n LABEL "600"\n LABEL "700"\n LABEL "800"\n LABEL "900"\n END\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"tabbook",children:"TABBOOK"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a tabbed area in which to place TABITEM widgets"})}),"\n",(0,r.jsx)(s.h3,{id:"tabitem",children:"TABITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a VERTICAL layout tab into which to place widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Tab text"}),(0,r.jsx)(s.td,{children:"Text to diplay in the tab"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TABBOOK\n TABITEM "Tab 1"\n LABEL "100"\n LABEL "200"\n END\n TABITEM "Tab 2"\n LABEL "300"\n LABEL "400"\n END\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"iframe",children:"IFRAME"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open external tools in an Iframe within OpenC3"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"URL"}),(0,r.jsx)(s.td,{children:"The path to the page to display in the iframe"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"IFRAME https://openc3.com 900 450\n"})}),"\n",(0,r.jsx)(s.h2,{id:"decoration-widgets",children:"Decoration Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.p,{children:"Decoration widgets are used to enhance the appearance of the screen. They do not respond to input, nor does the output vary with telemetry."}),"\n",(0,r.jsx)(s.h3,{id:"label",children:"LABEL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays text on the screen"})}),"\n",(0,r.jsx)(s.p,{children:"Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display on the label"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "Note: This is only a warning"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontalline",children:"HORIZONTALLINE"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Displays a horizontal line on the screen that can be used as a separator"})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABEL Over\nHORIZONTALLINE\nLABEL Under\n"})}),"\n",(0,r.jsx)(s.h3,{id:"sectionheader",children:"SECTIONHEADER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"DEPRECATED - Displays a label that is underlined with a horizontal line"})}),"\n",(0,r.jsx)(s.p,{children:"Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h3,{id:"title",children:"TITLE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a large centered title on the screen"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TITLE "Title"\nHORIZONTALLINE\nLABEL "Label"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"spacer",children:"SPACER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places a fixed size spacer in between widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the spacer in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the spacer in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'VERTICAL 3\n LABEL "Spacer below"\n SPACER 0 100\n LABEL "Spacer above"\nEND\n'})}),"\n",(0,r.jsx)(s.h2,{id:"telemetry-widgets",children:"Telemetry Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.p,{children:"Telemetry widgets are used to display telemetry values. The first parameters to each of these widgets is a telemetry mnemonic. Depending on the type and purpose of the telemetry item, the screen designer may select from a wide selection of widgets to display the value in the most useful format."}),"\n",(0,r.jsx)(s.h3,{id:"array",children:"ARRAY"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays ARRAY data organized into rows and space separated"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Items per row"}),(0,r.jsx)(s.td,{children:"Number of array items per row (default = 4)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'ARRAY INST HEALTH_STATUS ARY 250 80 "0x%x" 6 FORMATTED\nARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS\n'})}),"\n",(0,r.jsx)(s.h3,{id:"block",children:"BLOCK"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays BLOCK data organized into rows and space separated"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Bytes per word"}),(0,r.jsx)(s.td,{children:"Number of bytes per word (default = 4)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Words per row"}),(0,r.jsx)(s.td,{children:"Number of words per row (default = 4"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Address format"}),(0,r.jsx)(s.td,{children:"Format for the address printed at the beginning of each line (default = nil which means do not print an address)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'BLOCK INST IMAGE IMAGE 400 130 "%02X" 4 4 "0x%08X:"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"formatvalue",children:"FORMATVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a box with a formatted value"})}),"\n",(0,r.jsx)(s.p,{children:"Data is formatted by the specified string rather than by a format string given in the telemetry definition files. The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits)."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Printf style format string to apply to the telemetry item"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelled",children:"LABELLED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL followed by a LED"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Justification"}),(0,r.jsxs)(s.td,{children:["How to justify the label and LED together. The default of 'SPLIT' aligns the label to the left and the LED to the right with any additional space going between them. 'CENTER' pushes the label and LED together with any additional space to the left and right. 'LEFT' or 'RIGHT' pushes them to the respective side with the space going on the opposite.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"SPLIT, CENTER, LEFT, RIGHT"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELLED INST PARAMS VALUE1\n SETTING LED_COLOR GOOD GREEN\n SETTING LED_COLOR BAD RED\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to LABELLED. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"led_color",children:"LED_COLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LED color"}),(0,r.jsx)(s.td,{children:"Color of the LED"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelprogressbar",children:"LABELPROGRESSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a PROGRESSBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Scale factor"}),(0,r.jsx)(s.td,{children:"Value to multiply the telemetry item by before displaying in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0."}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the progress bar (default = 80 pixels"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW\nLABELPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvalue",children:"LABELVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a VALUE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELVALUE INST LATEST TIMESEC CONVERTED 18\nLABELVALUE INST LATEST COLLECT_TYPE\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluedesc",children:"LABELVALUEDESC"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the items description followed by a VALUE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Description"}),(0,r.jsx)(s.td,{children:"The description to display in the label (default is to display the description text associated with the telemetry item)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABELVALUEDESC INST HEALTH_STATUS TEMP1 "Temperature number 1" RAW 18\nLABELVALUEDESC INST HEALTH_STATUS COLLECT_TYPE\n'})}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluelimitsbar",children:"LABELVALUELIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluelimitscolumn",children:"LABELVALUELIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nLABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluerangebar",children:"LABELVALUERANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40\nLABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120\n"})}),"\n",(0,r.jsx)(s.h3,{id:"led",children:"LED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LED which changes color based on telemetry values"})}),"\n",(0,r.jsx)(s.p,{children:"By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LED INST PARAMS VALUE5 RAW 25 20 # Ellipse\n SETTING LED_COLOR 0 GREEN\n SETTING LED_COLOR 1 RED\n SETTING LED_COLOR ANY YELLOW\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to LED. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"led_color-1",children:"LED_COLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LED color"}),(0,r.jsx)(s.td,{children:"Color of the LED"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"limitsbar",children:"LIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item's current value within its colored limits horizontally"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50\nLIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"limitscolumn",children:"LIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item's current value within its colored limits vertically"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200\nLIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"limitscolor",children:"LIMITSCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a circle depicting the limits color of an item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Radius"}),(0,r.jsx)(s.td,{children:"Radius of the circle (default is 10)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Full Item Name"}),(0,r.jsx)(s.td,{children:"Show the full item name (default is false)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE\nLIMITSCOLOR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuelimitsbar",children:"VALUELIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuelimitscolumn",children:"VALUELIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSCOLUMN"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 8)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuerangebar",children:"VALUERANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by RANGEBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40\nVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120\n"})}),"\n",(0,r.jsx)(s.h3,{id:"linegraph",children:"LINEGRAPH"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a line graph of a telemetry item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LINEGRAPH INST HEALTH_STATUS TEMP1\n SETTING ITEM INST ADCS Q1 # Add additional item to graph\nLINEGRAPH INST HEALTH_STATUS TEMP2 RAW\nLINEGRAPH INST HEALTH_STATUS TEMP3 CONVERTED REDUCED_MINUTE MIN\n SETTING SIZE 600 500 # width height\n SETTING HISTORY 1h # load 1 hour of data into graph\nLINEGRAPH INST HEALTH_STATUS TEMP4\n SETTING HISTORY 30m # load 30 minutes of data into graph\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to LINEGRAPH. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"sparkline",children:"SPARKLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a sparkline graph (no cursor, scale or legend) of a telemetry item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"SPARKLINE INST HEALTH_STATUS TEMP1\n SETTING SIZE 400 50\n SETTING HISTORY 30s # Add 30 seconds of data into graph\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to SPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item-1",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime-1",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history-1",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed-1",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved-1",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed-1",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size-1",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelsparkline",children:"LABELSPARKLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a SPARKLINE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELSPARKLINE INST HEALTH_STATUS TEMP1\n SETTING HISTORY 5m # Add 5 minutes of data into graph\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item-2",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime-2",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history-2",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed-2",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved-2",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed-2",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size-2",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"imageviewer",children:"IMAGEVIEWER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display a base64 image from a TLM packet"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format"}),(0,r.jsx)(s.td,{children:"The image format of the base64 data (e.g. jpg, png, etc)"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"IMAGEVIEWER INST IMAGE IMAGE jpg\n"})}),"\n",(0,r.jsx)(s.h3,{id:"progressbar",children:"PROGRESSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a progress bar that is useful for displaying percentages"})}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"PROGRESSBAR INST ADCS POSPROGRESS 0.5 200\nPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,r.jsx)(s.h3,{id:"rangebar",children:"RANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a custom range bar displaying the item value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"RANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50\nRANGEBAR INST HEALTH_STATUS TEMP1 -100 100\n"})}),"\n",(0,r.jsx)(s.h3,{id:"textbox",children:"TEXTBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Provides a large box for multiline text"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the textbox in px (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the textbox in px (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70\nTEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED\n"})}),"\n",(0,r.jsx)(s.h3,{id:"value",children:"VALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a box with a telemetry item value"})}),"\n",(0,r.jsx)(s.p,{children:"The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits)."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUE INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h2,{id:"interactive-widgets",children:"Interactive Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.p,{children:"Interactive widgets are used to gather input from the user. Unlike all other widgets, which only output some graphical representation, interactive widgets permit input either from the keyboard or mouse."}),"\n",(0,r.jsx)(s.h3,{id:"button",children:"BUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a rectangular clickable button"})}),"\n",(0,r.jsxs)(s.p,{children:["Upon clicking, the button executes the Ruby code assigned. Buttons\ncan be used to send commands and perform other tasks. If you want your button\nto use values from other widgets, define them as named widgets and read their\nvalues using the ",(0,r.jsx)(s.code,{children:'screen.getNamedWidget("WIDGET_NAME").text()'})," method.\nSee the example in CHECKBUTTON."]}),"\n",(0,r.jsxs)(s.p,{children:["Button code can get rather complex so remember to use string concatenation\nto make things more readable. If you use ",(0,r.jsx)(s.code,{children:"+"})," newlines are inserted automatically\nduring string concatenation. If you use ",(0,r.jsx)(s.code,{children:"\\"})," you'll need to separate lines with a\nsingle semicolon ",(0,r.jsx)(s.code,{children:";"}),". COSMOS uses double semicolon ",(0,r.jsx)(s.code,{children:";;"})," to indicate lines should\nbe evaluated separately. Note that all OpenC3 commands (using api.cmd) must be\nseparated by ",(0,r.jsx)(s.code,{children:";;"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"You can send commands with buttons using api.cmd(). The cmd() syntax looks exactly\nlike the standard COSMOS Ruby scripting syntax. You can also request and use\ntelemetry in screens using Javascript Promises."}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE NORMAL, DURATION '+dur))\""})}),"\n",(0,r.jsx)(s.p,{children:"The api.tlm() function returns a Promise which is resolved with then()\nat which point we send the command with the telemetry value we received."}),"\n",(0,r.jsxs)(s.p,{children:["Scripts can be launched from a BUTTON using the ",(0,r.jsx)(s.code,{children:"runScript()"})," method. ",(0,r.jsx)(s.code,{children:"runScript()"})," takes three parameters,\nthe name of the script, whether to open the script in the foreground of Script Runner (default = true), and a hash of\nenvironment variables. For example: ",(0,r.jsx)(s.code,{children:"runScript('INST/procedures/script.rb', false, {'VAR': 'VALUE'})"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Button Text"}),(0,r.jsx)(s.td,{children:"Text displayed on the button"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Button Code"}),(0,r.jsx)(s.td,{children:"Javascript code to execute when the button is pressed"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"BUTTON 'Start Collect' 'api.cmd(\"INST COLLECT with TYPE NORMAL, DURATION 5\")'\nBUTTON 'Run Checks' 'runScript(\"INST/procedures/checks.rb\")'\n# More complex example with background checkbox and env vars\nNAMED_WIDGET SCRIPTNAME COMBOBOX collect.rb checks.rb\nNAMED_WIDGET BG CHECKBUTTON 'Background'\nBUTTON 'Run Script' \"var script=screen.getNamedWidget('SCRIPTNAME').text();\" \\\n # Set an environment variable to be used by the script as ENV['TYPE']\n \"var env = {}; env['TYPE'] = 'TEST';\" \\\n \"runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked(), env)\"\n"})}),"\n",(0,r.jsx)(s.h3,{id:"checkbutton",children:"CHECKBUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a check box"})}),"\n",(0,r.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Checkbox Text"}),(0,r.jsx)(s.td,{children:"Text displayed next to the checkbox"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks'\nBUTTON 'Send' 'screen.getNamedWidget(\"CHECK\").checked() ? ' \\\n 'api.cmd_no_hazardous_check(\"INST CLEAR\") : api.cmd(\"INST CLEAR\")'\n"})}),"\n",(0,r.jsx)(s.h3,{id:"combobox",children:"COMBOBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a drop down list of text items"})}),"\n",(0,r.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Option Text 1"}),(0,r.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Option Text n"}),(0,r.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"BUTTON 'Start Collect' 'var type = screen.getNamedWidget(\"COLLECT_TYPE\").text();' +\n 'api.cmd(\"INST COLLECT with TYPE \"+type+\", DURATION 10.0\")'\nNAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL\n"})}),"\n",(0,r.jsx)(s.h3,{id:"radiogroup",children:"RADIOGROUP"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a group of RADIOBUTTONs"})}),"\n",(0,r.jsx)(s.p,{children:"RADIOBUTTONs must be part of a group to enable selection logic"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Initial selected button"}),(0,r.jsx)(s.td,{children:"Selects a radio button at initialization (0-based)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.h3,{id:"radiobutton",children:"RADIOBUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a radio button and text"})}),"\n",(0,r.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET. It must be contained by a RADIOGROUP to enable typical selection of a single RADIOBUTTON."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display next to the radio button"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index\n RADIOBUTTON 'Abort'\n RADIOBUTTON 'Clear'\nEND\nBUTTON 'Send' \"screen.getNamedWidget('GROUP').selected() === 0 ? \" +\n \"api.cmd('INST ABORT') : api.cmd('INST CLEAR')\"\n"})}),"\n",(0,r.jsx)(s.h3,{id:"textfield",children:"TEXTFIELD"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a rectangular box where the user can enter text"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Characters"}),(0,r.jsx)(s.td,{children:"Width of the text field in characters (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Default text to put in the text field (default is blank)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'NAMED_WIDGET DURATION TEXTFIELD 12 "10.0"\nBUTTON \'Start Collect\' \'var dur = screen.getNamedWidget("DURATION").text();\' +\n \'api.cmd("INST COLLECT with TYPE NORMAL, DURATION "+dur+"")\'\n'})}),"\n",(0,r.jsx)(s.h2,{id:"canvas-widgets",children:"Canvas Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.p,{children:"Canvas Widgets are used to draw custom displays into telemetry screens. The canvas coordinate frame places (0,0) in the upper-left corner of the canvas."}),"\n",(0,r.jsx)(s.h3,{id:"canvas",children:"CANVAS"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Layout widget for the other canvas widgets"})}),"\n",(0,r.jsx)(s.p,{children:"All canvas widgets must be enclosed within a CANVAS widget."}),"\n",(0,r.jsx)(s.admonition,{type:"warning",children:(0,r.jsx)(s.p,{children:"The canvas coordinate frame places (0,0) in the upper-left corner of the canvas."})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvaslabel",children:"CANVASLABEL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws text onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to draw onto the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Font Size"}),(0,r.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the text"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'CANVAS 100 100\n CANVASLABEL 5 34 "Label1" 24 red\n CANVASLABEL 5 70 "Label2" 18 blue\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"canvaslabelvalue",children:"CANVASLABELVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws the text value of a telemetry item onto the canvas in an optional frame"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Font Size"}),(0,r.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the text"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"CANVAS 200 100\n CANVASLABELVALUE INST HEALTH_STATUS TEMP1 5 34 12 red\n CANVASLABELVALUE INST HEALTH_STATUS TEMP2 5 70 10 blue WITH_UNITS\nEND\n"})}),"\n",(0,r.jsx)(s.h3,{id:"canvasimage",children:"CANVASIMAGE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an image on the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image filename"}),(0,r.jsx)(s.td,{children:"Name of a image file. The file must be in the plugin's targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'CANVAS 250 430\n CANVASIMAGE "satellite.png" 10 10 200 200\n SETTING SCREEN INST HS\n CANVASIMAGE "https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=640&w=426" 0 250 250 150\nEND\n'})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"screen-1",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"Name of the target"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen name"}),(0,r.jsx)(s.td,{children:"Name of the screen"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasimagevalue",children:"CANVASIMAGEVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an image on the canvas that changes with a telemetry value"})}),"\n",(0,r.jsx)(s.p,{children:'Use various SETTING values to indicate which images should be displayed based on telemetry. For example, SETTING IMAGE CONNECTED "ground_on.png" 400 100. See the DEMO for a complete example.'}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Default image filename"}),(0,r.jsx)(s.td,{children:"The default image to display. The file must be in the targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image width"}),(0,r.jsx)(s.td,{children:"Width of the image (default is 100%)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image height"}),(0,r.jsx)(s.td,{children:"Height of the image (default is 100%)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'CANVAS 230 230\n CANVASIMAGEVALUE INST HEALTH_STATUS GROUND1STATUS CONVERTED "ground_error.png" 10 10 180 180\n SETTING IMAGE CONNECTED "ground_on.png" 10 10\n SETTING IMAGE UNAVAILABLE "ground_off.png" 10 10\n SETTING SCREEN INST HS\nEND\n'})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"image",children:"IMAGE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map an image to a state or value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image filename"}),(0,r.jsx)(s.td,{children:"Image to display. The file must be in the targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"screen-2",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"Name of the target"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen name"}),(0,r.jsx)(s.td,{children:"Name of the screen"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasline",children:"CANVASLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a line onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start X Position"}),(0,r.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End X Position"}),(0,r.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the line"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the line in pixels (default = 1)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"CANVAS 100 50\n CANVASLINE 5 5 95 5\n CANVASLINE 5 5 5 45 green 2\n CANVASLINE 95 5 95 45 blue 3\nEND\n"})}),"\n",(0,r.jsx)(s.h3,{id:"canvaslinevalue",children:"CANVASLINEVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a color changing line onto the canvas"})}),"\n",(0,r.jsx)(s.p,{children:"The line is represented by one of two colors based on the value of the associated telemetry item"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start X Position"}),(0,r.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End X Position"}),(0,r.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the line in pixels (default = 3)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"CANVAS 120 50\n CANVASLABELVALUE INST HEALTH_STATUS GROUND1STATUS 0 12 12 black\n CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 25 115 25 5 RAW\n SETTING VALUE_EQ 1 GREEN\n SETTING VALUE_EQ 0 RED\n CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 45 115 45\n SETTING VALUE_EQ CONNECTED GREEN\n SETTING VALUE_EQ UNAVAILABLE RED\nEND\n"})}),"\n",(0,r.jsx)(s.p,{children:"The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"value_eq",children:"VALUE_EQ"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Map a value to a color"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the line"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasdot",children:"CANVASDOT"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a dot onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Radius"}),(0,r.jsx)(s.td,{children:"Radius of the dot in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"CANVAS 50 50\n CANVASDOT 10 15 BLUE 5\nEND\n"})}),"\n",(0,r.jsx)(s.h2,{id:"example-file",children:"Example File"}),"\n",(0,r.jsx)(s.p,{children:"Example File: TARGET/myscreen.txt"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 0.5\nVERTICAL\n TITLE \"<%= target_name %> Commanding Examples\"\n LABELVALUE INST HEALTH_STATUS COLLECTS\n LABELVALUE INST HEALTH_STATUS COLLECT_TYPE\n LABELVALUE INST HEALTH_STATUS DURATION\n VERTICALBOX \"Send Collect Command:\"\n HORIZONTAL\n LABEL \"Type: \"\n NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL\n END\n HORIZONTAL\n LABEL \" Duration: \"\n NAMED_WIDGET DURATION TEXTFIELD 12 \"10.0\"\n END\n BUTTON 'Start Collect' \"api.cmd('INST COLLECT with TYPE '+screen.getNamedWidget('COLLECT_TYPE').text()+', DURATION '+screen.getNamedWidget('DURATION').text())\"\n END\n SETTING BACKCOLOR 163 185 163\n VERTICALBOX \"Parameter-less Commands:\"\n NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index\n RADIOBUTTON 'Abort'\n RADIOBUTTON 'Clear'\n END\n NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks' # No option is by default UNCHECKED\n BUTTON 'Send' \"screen.getNamedWidget('GROUP').selected() === 0 ? api.cmd('INST ABORT') : (screen.getNamedWidget('CHECK').checked() ? api.cmd_no_hazardous_check('INST CLEAR') : api.cmd('INST CLEAR'))\"\n END\n SETTING BACKCOLOR 163 185 163\nEND\n"})})]})}function x(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1184:(e,s,d)=>{d.d(s,{R:()=>i});var r=d(4041);const n={},t=r.createContext(n);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}}}]);

data/tools/staticdocs/assets/js/99b59eea.d4dd9989.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6670],{4094:e=>{e.exports=JSON.parse('{"title":"Development","slug":"/development","permalink":"/tools/staticdocs/docs/development","navigation":{"previous":{"title":"Scripting API Guide","permalink":"/tools/staticdocs/docs/guides/scripting-api"},"next":{"title":"Testing with Curl","permalink":"/tools/staticdocs/docs/development/curl"}}}')}}]);

data/tools/staticdocs/assets/js/a507c363.198e9246.js DELETED Viewed

@@ -1 +0,0 @@

- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7257],{704:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=t(1085),o=t(1184);const i={title:"Host Install"},l=void 0,a={id:"development/host-install",title:"Host Install",description:"Installing COSMOS Directly onto a Host (No Containers)",source:"@site/docs/development/host-install.md",sourceDirName:"development",slug:"/development/host-install",permalink:"/tools/staticdocs/docs/development/host-install",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/host-install.md",tags:[],version:"current",frontMatter:{title:"Host Install"},sidebar:"defaultSidebar",previous:{title:"Developing COSMOS",permalink:"/tools/staticdocs/docs/development/developing"},next:{title:"JSON API",permalink:"/tools/staticdocs/docs/development/json-api"}},r={},c=[{value:"Installing COSMOS Directly onto a Host (No Containers)",id:"installing-cosmos-directly-onto-a-host-no-containers",level:2}];function h(n){const e={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h2,{id:"installing-cosmos-directly-onto-a-host-no-containers",children:"Installing COSMOS Directly onto a Host (No Containers)"}),"\n",(0,s.jsx)(e.p,{children:"Note: THIS IS NOT A RECOMMENDED CONFIGURATION."}),"\n",(0,s.jsx)(e.p,{children:"COSMOS 5 is released as containers and intended to be run as containers. However, for various reasons someone might want to run COSMOS directly on a host. These instructions will walk through getting COSMOS 5 installed and running directly on RHEL 7 or Centos 7. This configuration will create a working install, but falls short of the ideal in that it does not setup the COSMOS processes as proper services on the host OS (that restart themselves on boot, and maintain themselves running in case of errors). Contributions that add that functionality are welcome."}),"\n",(0,s.jsx)(e.p,{children:"Let's get started."}),"\n",(0,s.jsxs)(e.ol,{children:["\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"The starting assumption is that you have a fresh install of either RHEL 7 or Centos 7. You are running as a normal user that has sudo permissions, and has git installed."}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"Start by downloading the latest working version of COSMOS from Github"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd ~\ngit clone https://github.com/openc3/cosmos.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"Run the COSMOS installation script"}),"\n",(0,s.jsx)(e.p,{children:"If you are feeling brave, you can run the one large installer script that installs everything in one step:"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd cosmos/examples/hostinstall/centos7\n./openc3_install.sh\n"})}),"\n",(0,s.jsx)(e.p,{children:"Or, you may want to break it down to the same steps that are in that script, and make sure each individual step is successful:"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd cosmos/examples/hostinstall/centos7\n./openc3_install_packages.sh\n./openc3_install_ruby.sh\n./openc3_install_redis.sh\n./openc3_install_minio.sh\n./openc3_install_traefik.sh\n./openc3_install_openc3.sh\n./openc3_start_services.sh\n./openc3_first_init.sh\n"})}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:["If all was successful, you should be able to open Firefox, and goto: ",(0,s.jsx)(e.a,{href:"http://localhost:2900",children:"http://localhost:2900"}),". Congrats you have COSMOS running directly on a host."]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"As stated at the beginning, this is not currently a supported configuration. Contributions that help to improve it are welcome."}),"\n"]}),"\n"]})]})}function d(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(h,{...n})}):h(n)}},1184:(n,e,t)=>{t.d(e,{R:()=>l});var s=t(4041);const o={},i=s.createContext(o);function l(n){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}}}]);