openc3-cosmos-tool-docs 5.12.0 → 5.14.0

data/tools/docs/assets/js/696b4199.ff9185d0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6560],{6310:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(7896),a=(n(2784),n(876));const i={sidebar_position:10,title:"SSL-TLS"},o=void 0,l={unversionedId:"configuration/ssl-tls",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/docs/docs/configuration/ssl-tls",draft:!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/docs/docs/configuration/telemetry-screens"},next:{title:"Tools",permalink:"/tools/docs/docs/tools"}},c={},s=[{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&#39;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}],p={toc:s},u="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"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,a.kt)("a",{parentName:"p",href:"https://doc.traefik.io/traefik/routing/entrypoints/#tls"},"docs"),"."),(0,a.kt)("h3",{id:"generate-the-certificate"},"Generate the certificate"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"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.")),(0,a.kt)("p",null,"To create a new Self-Signed SSL Certificate, use the openssl req command (run on linux from the cosmos-project root):"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"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")),(0,a.kt)("p",null,"Let's breakdown the command and understand what each option means:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"newkey rsa:4096")," - Creates a new certificate request and 4096 bit RSA key. The default one is 2048 bits."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"x509")," - Creates a X.509 Certificate."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"sha256")," - Use 265-bit SHA (Secure Hash Algorithm)."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"days 3650")," - The number of days to certify the certificate for. 3650 is ten years. You can use any positive integer."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"nodes")," - Creates a key without a passphrase."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"out ./openc3-traefik/cert.crt")," - Specifies the filename to write the newly created certificate to. You can specify any file name."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"keyout ./openc3-traefik/cert.key")," - Specifies the filename to write the newly created private key to. You can specify any file name.")),(0,a.kt)("p",null,"For more information about the ",(0,a.kt)("inlineCode",{parentName:"p"},"openssl req")," command options, visit the ",(0,a.kt)("a",{parentName:"p",href:"https://www.openssl.org/docs/man1.0.2/man1/openssl-req.html"},"OpenSSL req documentation page"),"."),(0,a.kt)("h3",{id:"updating-the-openc3-traefik-dockerfile"},"Updating the openc3-traefik Dockerfile"),(0,a.kt)("p",null,"Add the new cert to the traefik Docker container."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"--- 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")),(0,a.kt)("h3",{id:"updating-the-traefik-config"},"Updating the Traefik config"),(0,a.kt)("p",null,"Configure Traefik to use the new cert file."),(0,a.kt)("p",null,"openc3-traefik/traefik.yaml"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},'--- 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: ":80"\n+    http:\n+      redirections:\n+        entryPoint:\n+          to: websecure\n+          scheme: https\n+  websecure:\n+    address: ":443"\n+    http:\n+      tls:\n+        domains:\n+          - main: "\x3c!-- UPDATE WITH YOUR HOSTNAME HERE --\x3e"\n')),(0,a.kt)("h3",{id:"update-docker-composeyaml"},"Update docker-compose.yaml"),(0,a.kt)("p",null,"Update traefik to use secure port 443 instead of port 80."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},'--- 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-      - "2900:80"\n+      - "443:443"\n     restart: "unless-stopped"\n     depends_on:\n')),(0,a.kt)("p",null,"Now you can run ",(0,a.kt)("inlineCode",{parentName:"p"},"./openc3.sh start")," to rebuild the Traefik container and it should include your new cert file."),(0,a.kt)("h2",{id:"lets-encrypt"},"Let's Encrypt"),(0,a.kt)("h4",{id:"key"},"KEY"),(0,a.kt)("p",null,'privkey.pem is the "key" file'),(0,a.kt)("p",null,"Sometimes it is named as cert.key or example.com.key."),(0,a.kt)("h4",{id:"crt"},"CRT"),(0,a.kt)("p",null,'fullchain.pem is your "crt" file.'),(0,a.kt)("p",null,"Sometimes it is named as example.com.crt."),(0,a.kt)("h4",{id:"crtkey-bundle"},"CRT/KEY Bundle"),(0,a.kt)("p",null,"bundle.pem would be made like so: cat fullchain.pem privkey.pem > bundle.pem"),(0,a.kt)("p",null,"HAProxy is the only server that I know of that uses bundle.pem."),(0,a.kt)("h4",{id:"certpem"},"cert.pem"),(0,a.kt)("p",null,"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."),(0,a.kt)("p",null,"However, you don't generally use the cert.pem by itself. It's almost always coupled with chain.pem as fullchain.pem."),(0,a.kt)("h4",{id:"chainpem"},"chain.pem"),(0,a.kt)("p",null,"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."),(0,a.kt)("h3",{id:"checking-certs"},"Checking certs"),(0,a.kt)("p",null,"You can inspect the cert like so:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl x509 -in cert.pem -text -noout\n")),(0,a.kt)("h2",{id:"extracting-the-certificate-and-keys-from-a-pfx-file"},"Extracting the certificate and keys from a .pfx file"),(0,a.kt)("p",null,"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."),(0,a.kt)("h3",{id:"extract-crt-and-key-files-from-pfx-file"},"Extract .crt and .key files from .pfx file"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"PREREQUISITE: Ensure OpenSSL is installed in the server that contains the SSL certificate.")),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Start OpenSSL from the OpenSSL\\bin folder.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Open the command prompt and go to the folder that contains your .pfx file.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Run the following command to extract the private key:"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl pkcs12 -in [yourfile.pfx] -nocerts -out [drlive.key]\n")),(0,a.kt)("p",null,"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."),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Run the following command to extract the certificate:")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl pkcs12 -in [yourfile.pfx] -clcerts -nokeys -out [drlive.crt]\n")),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Run the following command to decrypt the private key:")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl rsa -in [drlive.key] -out [drlive-decrypted.key]\n")),(0,a.kt)("p",null,"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."),(0,a.kt)("h3",{id:"convert-pfx-file-to-pem-format"},"Convert .pfx file to .pem format"),(0,a.kt)("p",null,"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."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl rsa -in [keyfile-encrypted.key] -outform PEM -out [keyfile-encrypted-pem.key]\n")),(0,a.kt)("h2",{id:"tls12-inadequate_security-errors"},"TLS1.2 INADEQUATE_SECURITY Errors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://doc.traefik.io/traefik/https/tls/#cipher-suites"},"https://doc.traefik.io/traefik/https/tls/#cipher-suites")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://pkg.go.dev/crypto/tls#pkg-constants"},"https://pkg.go.dev/crypto/tls#pkg-constants"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-yaml"},"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")))}f.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},u="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=s(n),d=a,m=u["".concat(c,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(m,o(o({ref:t},p),{},{components:n})):r.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var s=2;s<i;s++)o[s]=n[s];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/6b210247.248680ef.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5120],{961:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:4,title:"Requirements and Design"},i=void 0,o={unversionedId:"getting-started/requirements",id:"getting-started/requirements",title:"Requirements and Design",description:"OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations.",source:"@site/docs/getting-started/requirements.md",sourceDirName:"getting-started",slug:"/getting-started/requirements",permalink:"/tools/docs/docs/getting-started/requirements",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/requirements.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Requirements and Design"},sidebar:"defaultSidebar",previous:{title:"Upgrading",permalink:"/tools/docs/docs/getting-started/upgrading"},next:{title:"Podman",permalink:"/tools/docs/docs/getting-started/podman"}},d={},m=[{value:"Terminology",id:"terminology",level:2},{value:"Overall Architecture and Context Diagram",id:"overall-architecture-and-context-diagram",level:2},{value:"Overall Requirements",id:"overall-requirements",level:2},{value:"Api Requirements",id:"api-requirements",level:2},{value:"Command and Telemetry Server",id:"command-and-telemetry-server",level:2},{value:"Limits Monitor",id:"limits-monitor",level:2},{value:"Command Sender",id:"command-sender",level:2},{value:"Script Runner",id:"script-runner",level:2},{value:"Packet Viewer",id:"packet-viewer",level:2},{value:"Telemetry Viewer",id:"telemetry-viewer",level:2},{value:"Telemetry Grapher",id:"telemetry-grapher",level:2},{value:"Data Extractor",id:"data-extractor",level:2},{value:"Data Viewer",id:"data-viewer",level:2},{value:"Calendar",id:"calendar",level:2},{value:"Admin",id:"admin",level:2}],p={toc:m},s="wrapper";function u(t){let{components:e,...a}=t;return(0,r.kt)(s,(0,n.Z)({},p,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,"OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations."),(0,r.kt)("p",null,"COSMOS is currently made up of the following applications:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Command and Telemetry Server")," - Provides status of realtime commanding, telemetry reception, logging, limits monitoring, and packet routing."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Limits Monitor")," - Monitors telemetry with defined limits and shows items that currently are or have violated limits."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Command Sender")," - Provides a graphical interface for manually sending individual commands."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Script Runner")," - Executes scripts and provides highlighting of the currently executing line. Now also includes TestRunner functionality."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Packet Viewer")," - Provides realtime visualization of every telemetry packet that has been defined."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Telemetry Viewer")," - Provides custom telemetry screen functionality with advanced layout and visualization widgets."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Telemetry Grapher")," - Provides realtime and offline graphing of telemetry data."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Data Extractor")," - Extracts telemetry and command packet log files into CSV data."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Data Viewer")," - Provides text based telemetry visualization for items."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Bucket Explorer")," - Browse the COSMOS bucket storage in any cloud environment."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Table Manager")," - Binary file editor with Script Runner integration for upload / download."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Handbooks")," - Generate html page of the command and telemetry definitions."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Calendar")," - Provides scheduling of commands and scripts. Also provides a framework for reserving resources."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Admin")," - Provides an administrative interface to COSMOS.")),(0,r.kt)("p",null,"More detailed descriptions, requirements, and design for each tool are found later in this document. Additionally, each of the above applications is built using COSMOS libraries that are available for use as a framework to develop custom program/project applications."),(0,r.kt)("h2",{id:"terminology"},"Terminology"),(0,r.kt)("p",null,"The COSMOS system uses several terms that are important to understand. The following table defines these terms."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Term"),(0,r.kt)("th",{parentName:"tr",align:null},"Definition"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target"),(0,r.kt)("td",{parentName:"tr",align:null},"A COSMOS target is an embedded system that the COSMOS Command and Telemetry Server connects to using an interface in order to send commands to and/or receive telemetry from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Command"),(0,r.kt)("td",{parentName:"tr",align:null},"A packet of information telling a target to perform an action of some sort.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Packet"),(0,r.kt)("td",{parentName:"tr",align:null},"A packet of information providing status from a target.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Interface"),(0,r.kt)("td",{parentName:"tr",align:null},"A Ruby class that knows how to send commands to and/or receive telemetry from a target. COSMOS comes with interfaces that support TCP/IP, UDP, and serial connections. Custom interfaces are easy to add to the system.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Ruby"),(0,r.kt)("td",{parentName:"tr",align:null},"The powerful dynamic programming language used to write the COSMOS applications and libraries as well as COSMOS scripts and test procedures.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Configuration Files"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS uses simple plain text configuration files to define commands and telemetry packets, and to configure each COSMOS application. These files are easily human readable/editable and machine readable/editable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Packet Log Files"),(0,r.kt)("td",{parentName:"tr",align:null},"Binary files containing either logged commands or telemetry packets.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Message Log Files"),(0,r.kt)("td",{parentName:"tr",align:null},"Text files containing messages generated by the system.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Tool"),(0,r.kt)("td",{parentName:"tr",align:null},"Another name for a COSMOS application.")))),(0,r.kt)("h2",{id:"overall-architecture-and-context-diagram"},"Overall Architecture and Context Diagram"),(0,r.kt)("p",null,"The following diagram shows the COSMOS 5 architecture."),(0,r.kt)("p",null,"COSMOS Architecture /img/v5/architecture.png"),(0,r.kt)("p",null,"Key aspects of this architecture:"),(0,r.kt)("p",null,"COSMOS 5 is a cloud native, containerized, microservice oriented command and control system. All the COSMOS microservices are docker containers which is why Docker is shown containing the entire COSMOS system. The green boxes on the left represent external embedded systems (Targets) which COSMOS connects to. The Redis data store contains the configuration for all the microservices, the current value table, as well as data streams containing decommutated data. The Minio data store contains plugins, targets, configuration data, text logs as well as binary logs of all the raw, decommutated, and reduced data. Users interact with COSMOS from a web browser which routes through the internal Traefik load balancer."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"COSMOS can connect to many different kinds of targets. The examples include things like Flight software (FSW), Ground Support Equipment (GSE), Labview, and COTS targets such as an Agilent power supply. Any embedded system that provides a communication interface can be connected to COSMOS."),(0,r.kt)("li",{parentName:"ul"},"COSMOS ships with interfaces for connecting over TCP/IP, UDP, MQTT, and serial connections. This covers most systems, but custom interfaces can also be written to connect to anything."),(0,r.kt)("li",{parentName:"ul"},"All realtime communication with targets flows through the COSMOS system. This ensures all commands and telemetry are logged."),(0,r.kt)("li",{parentName:"ul"},"Every tool is configured with plain text configuration files."),(0,r.kt)("li",{parentName:"ul"},"Program specific tools can be written using the COSMOS libraries that can interact with the realtime command and telemetry streams and can process logged data.")),(0,r.kt)("h2",{id:"overall-requirements"},"Overall Requirements"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-1"),(0,r.kt)("td",{parentName:"tr",align:null},"All COSMOS core functionality shall be containerized."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify COSMOS is running in Docker")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS user interface shall be accessible from Chromium based web browsers"),(0,r.kt)("td",{parentName:"tr",align:null},"Open COSMOS in Chrome/Edge")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS user interface shall be accessible from the Firefox web browser"),(0,r.kt)("td",{parentName:"tr",align:null},"Open COSMOS in Firefox")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-4"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall log all commands sent"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-5"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall log all telemetry received"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-6"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall decommutate all telemetry packets recieved"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-7"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall support autonomously attempting to connect to targets."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify targets are connected upon starting the CTS.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-8"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp telemetry packets upon receipt."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify logged packets are timestamped.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-9"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp telemetry packets to a resolution of 1 millisecond or better. Note: This requirement only refers to resolution. COSMOS does not run on real-time operating systems and accuracy cannot be guaranteed."),(0,r.kt)("td",{parentName:"tr",align:null},"View time stamps in log.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-10"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp received telemetry with a UTC timestamp."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify logged time stamps are as expected.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-11"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall maintain a timestamped log of commands received, limits violations, and errors encountered."),(0,r.kt)("td",{parentName:"tr",align:null},"View COSMOS message log.")))),(0,r.kt)("h2",{id:"api-requirements"},"Api Requirements"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted connection and disconnection of interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"Disconnect and connect an interface from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted connection and disconnection of routers."),(0,r.kt)("td",{parentName:"tr",align:null},"Disconnect and connect a router from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted setting of the current limits set."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a different limits set from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow commanding of targets"),(0,r.kt)("td",{parentName:"tr",align:null},"Send a command")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow reading the current value of any telemetry item"),(0,r.kt)("td",{parentName:"tr",align:null},"Read a telemetry point")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow streaming realtime and logged telemetry packets"),(0,r.kt)("td",{parentName:"tr",align:null},"Stream telemetry packets")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow streaming realtime and logged command packets"),(0,r.kt)("td",{parentName:"tr",align:null},"Stream command packets")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow starting COSMOS scripts"),(0,r.kt)("td",{parentName:"tr",align:null},"Start a script using the API")))),(0,r.kt)("h2",{id:"command-and-telemetry-server"},"Command and Telemetry Server"),(0,r.kt)("p",null,"The Command and Telemetry server provides status on the the overall COSMOS installation for a specific scope."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Interfaces tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manual connection and disconnection of interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"Press a GUI button to disconnect and connect an interface.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all targets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Targets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of known commands."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Cmd Packets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display raw command data for the most recent command received."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Cmd Packets tab and click the View Raw button for a command.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of known telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Tlm Packets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display raw telemetry packet data for the most recent telemetry packet received."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Tlm Packets tab and click the View Raw button for a telemetry packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all routers."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Routers tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-9"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manual connection and disconnection of routers."),(0,r.kt)("td",{parentName:"tr",align:null},"Press a GUI button to disconnect and connect a router.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-10"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manually setting the current limits set."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a different limits set from the combobox.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-11"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall support opening telemetry packets in Packet Viewer."),(0,r.kt)("td",{parentName:"tr",align:null},"On the Tlm Packets tab click View in Packet Viewer for a telemetry packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-12"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display time stamps in local time."),(0,r.kt)("td",{parentName:"tr",align:null},"View time stamps in log.")))),(0,r.kt)("h2",{id:"limits-monitor"},"Limits Monitor"),(0,r.kt)("p",null,"Limits Monitor displays all telemetry points that are currently out of limits and also shows any telemetry points that have gone out of limits since Limits Monitor was started."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall display all telemetry points currently out of limits."),(0,r.kt)("td",{parentName:"tr",align:null},"View displayed telemetry points.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support ignoring telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Click ignore on a telemetry point.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall keep a displayed log of limits violations."),(0,r.kt)("td",{parentName:"tr",align:null},"View the log tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall continue displaying a telemetry point that temporarily went out of limits."),(0,r.kt)("td",{parentName:"tr",align:null},"Watch until a telemetry points returns to green.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support saving its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Save the configuration.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support loading its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Load the configuration.")))),(0,r.kt)("h2",{id:"command-sender"},"Command Sender"),(0,r.kt)("p",null,"Command Sender provides an easy method to send single commands to targets. The graphical user interface provides simple dropdowns to quickly select the desired command to send organized by target name and command name. After the user has selected the command, they then fill in the desired command parameters and click send to send the command to the target."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow selection of a command by target name and packet name."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific command by target name and packet name in the drop down menus.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow sending the selected command."),(0,r.kt)("td",{parentName:"tr",align:null},"Send the selected command by pressing the Send button.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall display non-ignored parameters for the selected command."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific command and verify the expected parameters are shown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall provide a mechanism to select state values for command parameters with states."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific state value for a specific command with states.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow sending a manually entered value for a command parameter with states."),(0,r.kt)("td",{parentName:"tr",align:null},"Manually enter a value for a specific command with states.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall refuse to send commands if required parameters are not provided."),(0,r.kt)("td",{parentName:"tr",align:null},"Attempt to send a command with a required parameter not filled out.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall support sending commands while ignoring range checking."),(0,r.kt)("td",{parentName:"tr",align:null},"Enter Ignore Range Checking mode and then send a command with an out of range parameter.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall optionally display state values in hex."),(0,r.kt)("td",{parentName:"tr",align:null},'Enter "Display State Values in Hex" mode and verify state values are displayed as hex.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall optionally display ignored command parameters."),(0,r.kt)("td",{parentName:"tr",align:null},'Enter "Show Ignored Parameters" mode and verify ignored parameters are displayed.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall respect hazardous commands and notify the user before proceeding."),(0,r.kt)("td",{parentName:"tr",align:null},"Send a hazardous command and verify a dialog box appears before the command is sent. Verify both accepting the dialog and declining to send.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-11"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall keep a command history of each command sent."),(0,r.kt)("td",{parentName:"tr",align:null},"Send a command and verify that it shows up in the command history box.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-12"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow resending of any command in the command history."),(0,r.kt)("td",{parentName:"tr",align:null},"Resend one of the commands in the command history box.")))),(0,r.kt)("h2",{id:"script-runner"},"Script Runner"),(0,r.kt)("p",null,"Script Runner provides a visual interface for editing and executing scripts/procedures. A full featured text editor provides syntax highlighting and code completion while developing scripts. During script execution, the currently executing line is highlighted and any logged messages are highlighted to the user. If any failure occurs, the script is paused and the user alerted. The user can then decide whether to stop the script, or ignore the failure and continue. The user can also retry the failed lines, or other nearby lines before proceeding."),(0,r.kt)("p",null,"Script Runner now also provides a structured methodology for designing system level scripting that mirrors the very successful pattern used in software unit tests (previously implemented in the Test Runner tool). System level tests/procedures are built up of cases that are organized into groups. For example, you might have one group that verified all of the requirements associated with a particular mechanism. Ideally you would break this down into individual cases for different scenarios. One perhaps for opening a shutter, another for closing it, etc. Cases are ideally small and independent tasks. A number of these groups are then combined into an overall suite which would be run to execute a major test such as EMI, or software FQT."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide a text editor for developing test scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Open Script Runner and create a simple test script. Perform all standard file operations including New, Open, Reload, Close, Save, and Save As. Perform all standard editing operations such as Cut, Copy, Paste, Undo, Redo, Select All, and Comment/Uncomment lines.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide search and replace functionality."),(0,r.kt)("td",{parentName:"tr",align:null},"Perform all standard search and replace functionality, including search, replace, find next, and find previous.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide code completion for cmd(), tlm(), and wait_check() COSMOS API methods. Note: Other methods may also be supported."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script and exercise code completion on the mentioned keywords.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall execute Ruby-based COSMOS scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Press start and execute a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall highlight the currently executing line of the script."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify that lines are highlighted as a test script executes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall allow pausing an executing script."),(0,r.kt)("td",{parentName:"tr",align:null},"Press pause button and verify script is paused. Press start to resume.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall allow stopping an executing script."),(0,r.kt)("td",{parentName:"tr",align:null},"Press stop and verify script stops.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall pause an executing script upon the occurance of an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a statement that is guaranteed to fail and verify that the script is paused.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log commands sent."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that sends a command and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log text written to STDOUT. Note: Typically through the puts method."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that uses puts to write a message and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-11"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log wait times."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that includes a wait method and verify wait time is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-12"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log errors that occur while the script is executing."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a check statement that is guaranteed to fail and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-13"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log check statement success and failure."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a check statement that is guaranteed to fail and one that is guaranteed to succeeed. Verify both the success and failure are logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-14"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support executing selected lines."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a set of lines and execute them using Script->Execute Selected Lines.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-15"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support executing selected lines while paused."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a set of lines and execute them from the right-click context menu.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-16"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support starting a script from any line."),(0,r.kt)("td",{parentName:"tr",align:null},"Place the mouse cursor at the desired first line and then select Script->Execute From Cursor.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-17"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a mnemonic checking function."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Mnemonic Check.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-18"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a syntax checking function."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Ruby Syntax Check.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-19"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support viewing the script instrumentation."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->View Instrumented Script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-20"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support an disconnected mode to allow for executing scripts without a connection to the Command and Telemetry Server."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Toggle Disconnect. Execute a script with commands and check statements and verify that it runs to completion.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-21"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a Debug terminal to aid in debugging scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Toggle Debug.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-22"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a step mode where the script will stop and wait for use interaction after each line."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Step to progress through the script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-23"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support breakpoint functionality."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a breakpoint then execute the script and verify it stops at the specified line.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-25"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test suites."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test suite.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-26"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test groups."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test group.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-27"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test cases."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test case.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-28"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing test group setup and teardown methods individually."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test group setup. Execute a test group teardown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-29"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing test suite setup and teardown methods individually."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test suite setup. Execute a test suite teardown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-30"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall create a report after executing any suite test."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify a report is generated after executing a suite.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-31"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support pausing when an error occurs."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the pause on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-32"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support allowing the user to proceed on an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the Allow go/retry on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-33"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support aborting execution on an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the abort on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-34"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support looping a test."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the loop testing box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-35"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support breaking the looping of a test on error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the break loop on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-36"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support a user readable flag indicating that loop testing is occurring."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script that checks the $loop_testing variable while looping and again while not looping.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-37"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support a user readable flag indicating manual operations are desired."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the manual box checked and without.")))),(0,r.kt)("h2",{id:"packet-viewer"},"Packet Viewer"),(0,r.kt)("p",null,"Packet Viewer provides a simple tool to view the realtime contents of any telemetry packet defined in the system in a tabular, key-value format."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall allow selection of a telemetry packet by target name and packet name."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific telemetry packet by target name and packet name in the drop down menus.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall display the contents of the selected telemetry packet."),(0,r.kt)("td",{parentName:"tr",align:null},"Ensure all items of the selected telemetry packet are displayed and updating.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall provide a mechanism to get detailed information on a telemetry item."),(0,r.kt)("td",{parentName:"tr",align:null},'Right click on a telemetry item and select "Details" from the context menu.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall provide a mechanism to view a graph of any telemetry item."),(0,r.kt)("td",{parentName:"tr",align:null},'Right click on a telemetry item and select "Graph" from the context menu.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall color telemetry values based upon limits state."),(0,r.kt)("td",{parentName:"tr",align:null},"View a packet with items containing limits and verify they are colored.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support a configurable polling rate."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Options and change the polling rate.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support a color-blind mode to allow distinguishing limits states for those who are color blind."),(0,r.kt)("td",{parentName:"tr",align:null},"Select View->Color Blind Mode and verify that items with limits are also displayed with a textual indication of limits state color.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support displaying telemetry in each of the four COSMOS value types (raw, converted, formatted, and formatted with units)"),(0,r.kt)("td",{parentName:"tr",align:null},"In the View menu, select each of the four value types and verify values are displayed accordingly.")))),(0,r.kt)("h2",{id:"telemetry-viewer"},"Telemetry Viewer"),(0,r.kt)("p",null,'Telemetry Viewer provides a way to organize telemetry points into custom "screens" that allow for the creation of unique and organized views of telemetry data. Screens are made up of widgets or small GUI components that display telemetry in unique ways.'),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall display user-defined telemetry screens."),(0,r.kt)("td",{parentName:"tr",align:null},"Open a telemetry")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall display realtime data."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify telemetry screens show realtime data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall support saving open telemetry screens and their positions."),(0,r.kt)("td",{parentName:"tr",align:null},"Open three telemetry screens and then select File->Save Configuration.")))),(0,r.kt)("h2",{id:"telemetry-grapher"},"Telemetry Grapher"),(0,r.kt)("p",null,"Telemetry Grapher performs graphing of telemetry points in both realtime and log file playback."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall provide line graphs of telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Add several housekeeping data objects to a plot.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support realtime graphing of telemetry."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Start to start realtime graphing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing data from logged telemetry."),(0,r.kt)("td",{parentName:"tr",align:null},"Select the menu option to graph data from a logged data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support multiple plots per browser tab."),(0,r.kt)("td",{parentName:"tr",align:null},"Add multiple plots.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support multiple telemetry points per plot."),(0,r.kt)("td",{parentName:"tr",align:null},"Add multiple data objects to one plot.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support saving a variable number of data points."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Points Saved.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing a variable duration of time."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Seconds Plotted.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing a variable number of data points."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Points Plotted.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support saving its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Save the current configuration.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support loading its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Load the previously saved configuration.")))),(0,r.kt)("h2",{id:"data-extractor"},"Data Extractor"),(0,r.kt)("p",null,"Data Extractor processes logged data and extracts data into a CSV format for analysis in Excel or other tools."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding individual telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Add an individual telemetry point.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding entire telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Add an entire packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding entire telemetry targets."),(0,r.kt)("td",{parentName:"tr",align:null},"Add all packets for a target.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support selecting the value type to extract for each telemetry point (RAW, CONVERTED, FORMATTED, WITH_UNITS)"),(0,r.kt)("td",{parentName:"tr",align:null},"Click an item and change the value type.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support saving configurations."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Save Config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support loading configurations."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Load Config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support deleting items"),(0,r.kt)("td",{parentName:"tr",align:null},"Select an Item and press delete")))),(0,r.kt)("h2",{id:"data-viewer"},"Data Viewer"),(0,r.kt)("p",null,"Data Viewer provides for textual display of telemetry packets where other display methods are not a good fit. It is especially useful for memory dumps and for log message type data display."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support realtime processing of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Start to start realtime processing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support logged playback of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a time range to playback.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support textual display of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the display of data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support multiple tabs for data display."),(0,r.kt)("td",{parentName:"tr",align:null},"Switch between several tabs of data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support deleting tabs."),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a tab.")))),(0,r.kt)("h2",{id:"calendar"},"Calendar"),(0,r.kt)("p",null,"Calendar"),(0,r.kt)("p",null,"The Calendar tool provides a user interface and API for initiating scheduled actions in COSMOS"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow creating new timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Click the button and create a new timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow scheduling commands for future execection"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a command to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow scheduling scripts for future execution"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a script to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow for reserving a resource"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a reservation to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall track success or failure of commands"),(0,r.kt)("td",{parentName:"tr",align:null},"Look at status from a completed command")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall track success or failure of scripts"),(0,r.kt)("td",{parentName:"tr",align:null},"Look at status from a completed script")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow deleting activities from timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a preexisting item from a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow deleting timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a timeline")))),(0,r.kt)("h2",{id:"admin"},"Admin"),(0,r.kt)("p",null,"Admin"),(0,r.kt)("p",null,"The Admin tool provides administrative functionality including managing plugins for the COSMOS system"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall allow installing plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Upload and Install a Plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support upgrading plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Upgrade an installed plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support uninstalling plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Uninstall a plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall display information on installed plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"View info on Interfaces, Microservices, etc")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support editing microservices"),(0,r.kt)("td",{parentName:"tr",align:null},"Edit the settings for a microservice")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support discovery of plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Discover and download a plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support adding links to external tools"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a link to Google")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support reordering tools"),(0,r.kt)("td",{parentName:"tr",align:null},"Reorder tools on the tools tab")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-9"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support configuring a classification bar"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a classification bar on the settings tab")))))}u.isMDXComponent=!0},876:(t,e,a)=>{a.d(e,{Zo:()=>p,kt:()=>g});var n=a(2784);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function l(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function i(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?l(Object(a),!0).forEach((function(e){r(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function o(t,e){if(null==t)return{};var a,n,r=function(t,e){if(null==t)return{};var a,n,r={},l=Object.keys(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),m=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):i(i({},e),t)),a},p=function(t){var e=m(t.components);return n.createElement(d.Provider,{value:e},t.children)},s="mdxType",u={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},c=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,d=t.parentName,p=o(t,["components","mdxType","originalType","parentName"]),s=m(a),c=r,g=s["".concat(d,".").concat(c)]||s[c]||u[c]||l;return a?n.createElement(g,i(i({ref:e},p),{},{components:a})):n.createElement(g,i({ref:e},p))}));function g(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var d in e)hasOwnProperty.call(e,d)&&(o[d]=e[d]);o.originalType=t,o[s]="string"==typeof t?t:r,i[1]=o;for(var m=2;m<l;m++)i[m]=a[m];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}c.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/6b65133b.2144fb1b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6744],{7307:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var i=n(7896),r=(n(2784),n(876));const o={title:"Telemetry Viewer"},a=void 0,l={unversionedId:"tools/tlm-viewer",id:"tools/tlm-viewer",title:"Telemetry Viewer",description:"Introduction",source:"@site/docs/tools/tlm-viewer.md",sourceDirName:"tools",slug:"/tools/tlm-viewer",permalink:"/tools/docs/docs/tools/tlm-viewer",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/tlm-viewer.md",tags:[],version:"current",frontMatter:{title:"Telemetry Viewer"},sidebar:"defaultSidebar",previous:{title:"Telemetry Grapher",permalink:"/tools/docs/docs/tools/tlm-grapher"},next:{title:"Guides",permalink:"/tools/docs/docs/guides"}},c={},s=[{value:"Introduction",id:"introduction",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Open Configuration",id:"open-configuration",level:4},{value:"Save Configuration",id:"save-configuration",level:4},{value:"Selecting Screens",id:"selecting-screens",level:2},{value:"New Screen",id:"new-screen",level:2},{value:"Edit Screen",id:"edit-screen",level:2},{value:"Screen Window Management",id:"screen-window-management",level:2},{value:"Building Screens",id:"building-screens",level:2}],d={toc:s},u="wrapper";function p(e){let{components:t,...o}=e;return(0,r.kt)(u,(0,i.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"Telemetry Viewer is a live telemetry viewer which displays custom built screens. Screens are configured through simple text files which utilize numerous build-in widgets."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(1625).Z,width:"1064",height:"818"})),(0,r.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,r.kt)("img",{src:"/img/v5/telemetry_viewer/file_menu.png",alt:"File Menu",style:{float:"left","margin-right":"50px",height:"80px"}}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Open a saved configuration"),(0,r.kt)("li",{parentName:"ul"},"Save the current configuration")),(0,r.kt)("h4",{id:"open-configuration"},"Open Configuration"),(0,r.kt)("p",null,"The Open and Save Configuration options deserve a little more explanation. When you select File Open the Open Configuration dialog appears. It displays a list of all saved configurations (TVAC in this example). You select a configuration and then click Ok to load it. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Open Config",src:n(2623).Z,width:"537",height:"249"})),(0,r.kt)("h4",{id:"save-configuration"},"Save Configuration"),(0,r.kt)("p",null,"When you select File Save the Save Configuration dialog appears. It displays a list of all saved configurations (TVAC in this example). You click the Configuration Name text field, enter the name of your new configuration, and click Ok to save. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Save Config",src:n(5341).Z,width:"537",height:"291"})),(0,r.kt)("h2",{id:"selecting-screens"},"Selecting Screens"),(0,r.kt)("p",null,"Selecting a target from the Select Target drop down automatically updates the available screens for that target in the Select Screen drop down. Clicking Show Screen causes that screen to display."),(0,r.kt)("h2",{id:"new-screen"},"New Screen"),(0,r.kt)("p",null,"Clicking New Screen brings up the new screen dialog."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(5148).Z,width:"536",height:"300"})),(0,r.kt)("p",null,"Screens are owned by Targets so Select Target chooses where the screen will be created. Screen names must be unique so all the existing screen names are listed for that target. Screens can be based on a Packet such that all the items in that particular packet will be generated in a simple vertical screen similar to Packet Viewer. This is a good starting point for customizing a screen."),(0,r.kt)("h2",{id:"edit-screen"},"Edit Screen"),(0,r.kt)("p",null,"Clicking the pencil icon in the title bar of the screen brings up the edit dialog."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(6289).Z,width:"796",height:"673"})),(0,r.kt)("p",null,"The screen source is displayed in an editor with syntax highlighting and auto-completion. You can download the screen source using the download button in the upper right or delete the screen using the trash icon in the upper left. Click Save to save the screen edits at which point Telemetry Viewer will re-render the screen."),(0,r.kt)("h2",{id:"screen-window-management"},"Screen Window Management"),(0,r.kt)("p",null,"All screens can be moved around the browser window by clicking their title bar and moving them. Other screens will move around intelligently to fill the space. This allows you to order the screens no matter which order they were created in."),(0,r.kt)("p",null,"Each screen has buttons in the upper right of the title bar. The line button minimizes the screen to effectively hide it. This allows you to focus on a single screen without closing existing screens."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Minimized",src:n(6179).Z,width:"537",height:"202"})),(0,r.kt)("p",null,"The X button closes the screen."),(0,r.kt)("h2",{id:"building-screens"},"Building Screens"),(0,r.kt)("p",null,"For documentation on how to build Telemetry Screens and how to configure the\nscreen widgets please see the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry-screens"},"Telemetry Screens"),"."))}p.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var i=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,i,r=function(e,t){if(null==e)return{};var n,i,r={},o=Object.keys(e);for(i=0;i<o.length;i++)n=o[i],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i<o.length;i++)n=o[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=i.createContext({}),s=function(e){var t=i.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},g=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=s(n),g=r,h=u["".concat(c,".").concat(g)]||u[g]||p[g]||o;return n?i.createElement(h,a(a({ref:t},d),{},{components:n})):i.createElement(h,a({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=g;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[u]="string"==typeof e?e:r,a[1]=l;for(var s=2;s<o;s++)a[s]=n[s];return i.createElement.apply(null,a)}return i.createElement.apply(null,n)}g.displayName="MDXCreateElement"},6289:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/edit_screen-5724ae13958c1631b3c187cf7cdb6dc9672ecd71f8b0786ac17c0266001edac3.png"},6179:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/minimized-59d0d8d8a179ff0475787e87237b77b24d59d78826d43dbc1a554a51380eb37f.png"},5148:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/new_screen-295720ec60219194c8c8dd64c755e8a188cc4a68c2b6cf66197b54514644d52a.png"},2623:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/open_config-2e61415a3c2d7a4ce427cf325f3708dd4a761092b7dd0c869279c4354dc34ae4.png"},5341:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/save_config-e748a338526ffd8f9e49def5c0d15f8a80cd987f40d210ff6c6d4b61b713555c.png"},1625:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/telemetry_viewer-be6ee576f1efceb39c2f744889deb4c18f571c4922c69d5d0e5f49a653776a46.png"}}]);

data/tools/docs/assets/js/6f92e431.608f28e7.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7476],{7475:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>p,toc:()=>l});var o=r(7896),n=(r(2784),r(876));const a={title:"Roadmap"},c=void 0,p={unversionedId:"development/roadmap",id:"development/roadmap",title:"Roadmap",description:"Our product roadmap is a Github Project found at the link below.",source:"@site/docs/development/roadmap.md",sourceDirName:"development",slug:"/development/roadmap",permalink:"/tools/docs/docs/development/roadmap",draft:!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/docs/docs/development/log-structure"},next:{title:"Streaming API",permalink:"/tools/docs/docs/development/streaming-api"}},i={},l=[],u={toc:l},s="wrapper";function d(e){let{components:t,...r}=e;return(0,n.kt)(s,(0,o.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"Our product roadmap is a Github Project found at the link below."),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/orgs/openc3/projects/2/views/1"},"Roadmap")),(0,n.kt)("p",null,"If you would like to commit feature ideas for our roadmap, please do so with normal Github issues at the main repo."))}d.isMDXComponent=!0},876:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var o=r(2784);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function c(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function p(e,t){if(null==e)return{};var r,o,n=function(e,t){if(null==e)return{};var r,o,n={},a=Object.keys(e);for(o=0;o<a.length;o++)r=a[o],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)r=a[o],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=o.createContext({}),l=function(e){var t=o.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},u=function(e){var t=l(e.components);return o.createElement(i.Provider,{value:t},e.children)},s="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,a=e.originalType,i=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),s=l(r),m=n,f=s["".concat(i,".").concat(m)]||s[m]||d[m]||a;return r?o.createElement(f,c(c({ref:t},u),{},{components:r})):o.createElement(f,c({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var a=r.length,c=new Array(a);c[0]=m;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[s]="string"==typeof e?e:n,c[1]=p;for(var l=2;l<a;l++)c[l]=r[l];return o.createElement.apply(null,c)}return o.createElement.apply(null,r)}m.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/72c6d8a8.062b7650.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7445],{7489:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:4,title:"Commands"},i=void 0,o={unversionedId:"configuration/command",id:"configuration/command",title:"Commands",description:"Command Definition Files",source:"@site/docs/configuration/command.md",sourceDirName:"configuration",slug:"/configuration/command",permalink:"/tools/docs/docs/configuration/command",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/command.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Commands"},sidebar:"defaultSidebar",previous:{title:"Targets",permalink:"/tools/docs/docs/configuration/target"},next:{title:"Telemetry",permalink:"/tools/docs/docs/configuration/telemetry"}},s={},m=[{value:"Command Definition Files",id:"command-definition-files",level:2},{value:"COMMAND",id:"command",level:2},{value:"COMMAND Modifiers",id:"command-modifiers",level:2},{value:"PARAMETER",id:"parameter",level:3},{value:"PARAMETER Modifiers",id:"parameter-modifiers",level:3},{value:"FORMAT_STRING",id:"format_string",level:4},{value:"UNITS",id:"units",level:4},{value:"DESCRIPTION",id:"description",level:4},{value:"META",id:"meta",level:4},{value:"OVERLAP",id:"overlap",level:4},{value:"KEY",id:"key",level:4},{value:"REQUIRED",id:"required",level:4},{value:"MINIMUM_VALUE",id:"minimum_value",level:4},{value:"MAXIMUM_VALUE",id:"maximum_value",level:4},{value:"DEFAULT_VALUE",id:"default_value",level:4},{value:"STATE",id:"state",level:4},{value:"WRITE_CONVERSION",id:"write_conversion",level:4},{value:"POLY_WRITE_CONVERSION",id:"poly_write_conversion",level:4},{value:"SEG_POLY_WRITE_CONVERSION",id:"seg_poly_write_conversion",level:4},{value:"GENERIC_WRITE_CONVERSION_START",id:"generic_write_conversion_start",level:4},{value:"GENERIC_WRITE_CONVERSION_END",id:"generic_write_conversion_end",level:4},{value:"OVERFLOW",id:"overflow",level:4},{value:"APPEND_PARAMETER",id:"append_parameter",level:3},{value:"ID_PARAMETER",id:"id_parameter",level:3},{value:"APPEND_ID_PARAMETER",id:"append_id_parameter",level:3},{value:"ARRAY_PARAMETER",id:"array_parameter",level:3},{value:"APPEND_ARRAY_PARAMETER",id:"append_array_parameter",level:3},{value:"SELECT_PARAMETER",id:"select_parameter",level:3},{value:"DELETE_PARAMETER",id:"delete_parameter",level:3},{value:"HIDDEN",id:"hidden",level:3},{value:"DISABLED",id:"disabled",level:3},{value:"DISABLE_MESSAGES",id:"disable_messages",level:3},{value:"META",id:"meta-1",level:3},{value:"HAZARDOUS",id:"hazardous",level:3},{value:"ACCESSOR",id:"accessor",level:3},{value:"TEMPLATE",id:"template",level:3},{value:"TEMPLATE_FILE",id:"template_file",level:3},{value:"SELECT_COMMAND",id:"select_command",level:2},{value:"Example File",id:"example-file",level:2}],d={toc:m},p="wrapper";function u(e){let{components:t,...a}=e;return(0,r.kt)(p,(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"command-definition-files"},"Command Definition Files"),(0,r.kt)("p",null,"Command definition files define the command packets that can be sent to COSMOS targets. One large file can be used to define the command packets, or multiple files can be used at the user's discretion. Command definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some command files that depend on others, e.g. they override or extend existing commands, they must be named last. The easist way to do this is to add an extension to an existing file name. For example, if you already have cmd.txt you can create cmd_override.txt for commands that depends on the definitions in cmd.txt. Also note that due to the way the ",(0,r.kt)("a",{parentName:"p",href:"http://www.asciitable.com/"},"ASCII Table")," is structured, files beginning with capital letters are processed before lower case letters."),(0,r.kt)("p",null,"When defining command parameters you can choose from the following data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data. The only difference between a STRING and BLOCK is when COSMOS reads the binary command log it stops reading a STRING type when it encounters a null byte (0). This shows up in the text log produced by Data Extractor. Note that this does NOT affect the data COSMOS writes as it's still legal to pass null bytes (0) in STRING parameters."),(0,r.kt)("div",{style:{clear:"both"}}),(0,r.kt)("h1",{id:"command-keywords"},"Command Keywords"),(0,r.kt)("h2",{id:"command"},"COMMAND"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a new command packet")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the target this command is associated with"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Command"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of this command. Also referred to as its mnemonic. Must be unique to commands to this target. Ideally will be as short and clear as possible."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Description"),(0,r.kt)("td",{parentName:"tr",align:null},"Description of this command which must be enclosed with quotes"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'COMMAND INST COLLECT BIG_ENDIAN "Start collect"\n')),(0,r.kt)("h2",{id:"command-modifiers"},"COMMAND Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a COMMAND keyword."),(0,r.kt)("h3",{id:"parameter"},"PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a command parameter in the current command packet")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"\nPARAMETER DATA 32 32 INT MIN MAX 0 "Data value"\nPARAMETER VALUE 64 32 FLOAT 0 10.5 2.5\nPARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"\nPARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"\n')),(0,r.kt)("h3",{id:"parameter-modifiers"},"PARAMETER Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a PARAMETER keyword."),(0,r.kt)("h4",{id:"format_string"},"FORMAT_STRING"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds printf style formatting")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Format"),(0,r.kt)("td",{parentName:"tr",align:null},"How to format using printf syntax. For example, '0x%0X' will display the value in hex."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'FORMAT_STRING "0x%0X"\n')),(0,r.kt)("h4",{id:"units"},"UNITS"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Add displayed units")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Full Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Full name of the units type, e.g. Celsius"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviated"),(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviation for the units, e.g. C"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"UNITS Celsius C\nUNITS Kilometers KM\n")),(0,r.kt)("h4",{id:"description"},"DESCRIPTION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined description")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new description"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"meta"},"META"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Stores custom user metadata")),(0,r.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'META TEST "This parameter is for test purposes only"\n')),(0,r.kt)("h4",{id:"overlap"},"OVERLAP"),(0,r.kt)("div",{class:"right"},"(Since 4.4.1)"),"**This item is allowed to overlap other items in the packet**",(0,r.kt)("p",null,"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message."),(0,r.kt)("h4",{id:"key"},"KEY"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the key used to access this raw value in the packet.**",(0,r.kt)("p",null,"Keys are often JsonPath or XPath strings"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key string"),(0,r.kt)("td",{parentName:"tr",align:null},"The key to access this item"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"KEY $.book.title\n")),(0,r.kt)("h4",{id:"required"},"REQUIRED"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Parameter is required to be populated in scripts")),(0,r.kt)("p",null,"When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition."),(0,r.kt)("h4",{id:"minimum_value"},"MINIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined minimum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new minimum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"maximum_value"},"MAXIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined maximum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new maximum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"default_value"},"DEFAULT_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined default value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new default value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"state"},"STATE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a key/value pair for the current command parameter")),(0,r.kt)("p",null,"Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key"),(0,r.kt)("td",{parentName:"tr",align:null},"The string state name"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The numerical state value"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous / Disable Messages"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"HAZARDOUS")),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous Description"),(0,r.kt)("td",{parentName:"tr",align:null},"String describing why this state is hazardous"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_PARAMETER ENABLE 32 UINT 0 1 0 "Enable setting"\n  STATE FALSE 0\n  STATE TRUE 1\nAPPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"\n  STATE "NOOP" "NOOP" DISABLE_MESSAGES\n  STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"\n  STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"\n')),(0,r.kt)("h4",{id:"write_conversion"},"WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Applies a conversion when writing the current command parameter")),(0,r.kt)("p",null,"Conversions are implemented in a custom Ruby file which should be located in the target's lib folder and required by the target's target.txt file (see REQUIRE). The class must require 'openc3/conversions/conversion' and inherit from Conversion. It must implement the initialize method if it takes extra parameters and must always implement the call method. The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Class Filename"),(0,r.kt)("td",{parentName:"tr",align:null},"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional parameter values for the conversion which are passed to the class constructor."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"WRITE_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * multiplier\n    end\n  end\nend\n")),(0,r.kt)("h4",{id:"poly_write_conversion"},"POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"POLY_WRITE_CONVERSION 10 0.5 0.25\n")),(0,r.kt)("h4",{id:"seg_poly_write_conversion"},"SEG_POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a segmented polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Lower Bound"),(0,r.kt)("td",{parentName:"tr",align:null},"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n")),(0,r.kt)("h4",{id:"generic_write_conversion_start"},"GENERIC_WRITE_CONVERSION_START"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Start a generic write conversion")),(0,r.kt)("p",null,"Adds a generic conversion function to the current command parameter. This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent. The conversion is specified as ruby code that receives two implied parameters. 'value' which is the raw value being written and 'packet' which is a reference to the command packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of ruby code given should return the converted value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of ruby code for the conversion have been given."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("div",{class:"note warning"},(0,r.kt)("p",null,"Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance.")),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n")),(0,r.kt)("h4",{id:"generic_write_conversion_end"},"GENERIC_WRITE_CONVERSION_END"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Complete a generic write conversion")),(0,r.kt)("h4",{id:"overflow"},"OVERFLOW"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set the behavior when writing a value overflows the type")),(0,r.kt)("p",null,"By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be writen, e.g. you can successfully write 255 to a 8 bit signed value."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Behavior"),(0,r.kt)("td",{parentName:"tr",align:null},"How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"OVERFLOW TRUNCATE\n")),(0,r.kt)("h3",{id:"append_parameter"},"APPEND_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a command parameter in the current command packet")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"\nAPPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5\nAPPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"\n')),(0,r.kt)("h3",{id:"id_parameter"},"ID_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines an identification command parameter in the current command packet")),(0,r.kt)("p",null,"ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| ID Value | Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"\n')),(0,r.kt)("h3",{id:"append_id_parameter"},"APPEND_ID_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines an identification command parameter in the current command packet")),(0,r.kt)("p",null,"ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| ID Value | Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"\n')),(0,r.kt)("h3",{id:"array_parameter"},"ARRAY_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a command parameter in the current command packet that is an array")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Item Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of each array item"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Item Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of each array item",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Array Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Description"),(0,r.kt)("td",{parentName:"tr",align:null},"Description which must be enclosed with quotes"),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates if the data is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"\n')),(0,r.kt)("h3",{id:"append_array_parameter"},"APPEND_ARRAY_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a command parameter in the current command packet that is an array")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the command."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Item Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of each array item"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Item Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of each array item",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Array Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Description"),(0,r.kt)("td",{parentName:"tr",align:null},"Description which must be enclosed with quotes"),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates if the data is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"\n')),(0,r.kt)("h3",{id:"select_parameter"},"SELECT_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Selects an existing command parameter for editing")),(0,r.kt)("p",null,"Must be used in conjunction with SELECT_COMMAND to first select the packet. Typically used to override generated values or make specific changes to commands that only affect a particular instance of a target used multiple times."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter to select for modification"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n")),(0,r.kt)("h3",{id:"delete_parameter"},"DELETE_PARAMETER"),(0,r.kt)("div",{class:"right"},"(Since 4.4.1)"),"**Deletes an existing command parameter from the packet definition**",(0,r.kt)("p",null,'Deleting a parameter from the command definition does not remove the defined space for that parameter. Thus unless you redefine a new parameter, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_COMMAND and then PARAMETER to define a new parameter.'),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter to delete"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_COMMAND INST COLLECT\n  DELETE_PARAMETER DURATION\n")),(0,r.kt)("h3",{id:"hidden"},"HIDDEN"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator")),(0,r.kt)("p",null,"Hidden commands do not appear in the Script Runner popup helper when writing scripts. The command still exists in the system and can be sent by scripts."),(0,r.kt)("h3",{id:"disabled"},"DISABLED"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Disables this command from being sent")),(0,r.kt)("p",null,"Hides the command and also disables it from being sent by scripts. Attempts to send DISABLED commands result in an error message."),(0,r.kt)("h3",{id:"disable_messages"},"DISABLE_MESSAGES"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Disable the Server from printing cmd(...) messages. Commands are still logged.")),(0,r.kt)("h3",{id:"meta-1"},"META"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Stores metadata for the current command")),(0,r.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'META FSW_TYPE "struct command"\n')),(0,r.kt)("h3",{id:"hazardous"},"HAZARDOUS"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Designates the current command as hazardous")),(0,r.kt)("p",null,"Sending a hazardous command causes a dialog asking for confirmation before sending the command"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Description"),(0,r.kt)("td",{parentName:"tr",align:null},"Description for why the command is hazardous which must be enclosed with quotes"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h3",{id:"accessor"},"ACCESSOR"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the class used to read and write raw values from the packet**",(0,r.kt)("p",null,"Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Accessor Class Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the accessor class"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"template"},"TEMPLATE"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines a template string used to initialize the command before default values are filled in**",(0,r.kt)("p",null,"Generally the template string is formatted in JSON or HTML and then values are filled in with command parameters. Must be UTF-8 encoded."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Template"),(0,r.kt)("td",{parentName:"tr",align:null},"The template string which should be enclosed in quotes"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"template_file"},"TEMPLATE_FILE"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines a template file used to initialize the command before default values are filled in**",(0,r.kt)("p",null,"Generally the template file is formatted in JSON or HTML and then values are filled in with command parameters. Can be binary or UTF-8."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Template File Path"),(0,r.kt)("td",{parentName:"tr",align:null},"The relative path to the template file. Filename should generally start with an underscore."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"select_command"},"SELECT_COMMAND"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Selects an existing command packet for editing")),(0,r.kt)("p",null,"Typically used in a separate configuration file from where the original command is defined to override or add to the existing command definition. Must be used in conjunction with SELECT_PARAMETER to change an individual parameter."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the target this command is associated with"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Command Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the command to select"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n")),(0,r.kt)("h2",{id:"example-file"},"Example File"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Example File: TARGET/cmd_tlm/cmd.txt")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'COMMAND TARGET COLLECT_DATA BIG_ENDIAN "Commands my target to collect data"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 100 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 4 4 4 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  PARAMETER ANGLE 48 32 FLOAT -180.0 180.0 0.0 "ANGLE OF INSTRUMENT IN DEGREES"\n  POLY_WRITE_CONVERSION 0 0.01745 0 0\n  PARAMETER MODE 80 8 UINT 0 1 0 "DATA COLLECTION MODE"\n    STATE NORMAL 0\n    STATE DIAG 1\nCOMMAND TARGET NOOP BIG_ENDIAN "Do Nothing"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 101 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  PARAMETER DUMMY 48 8 UINT 0 0 0 "DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"\nCOMMAND TARGET SETTINGS BIG_ENDIAN "Set the Settings"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 102 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  <% 5.times do |x| %>\n  APPEND_PARAMETER SETTING<%= x %> 16 UINT 0 5 0 "Setting <%= x %>"\n  <% end %>\n')))}u.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),m=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=m(e.components);return n.createElement(s.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),p=m(a),N=r,k=p["".concat(s,".").concat(N)]||p[N]||u[N]||l;return a?n.createElement(k,i(i({ref:t},d),{},{components:a})):n.createElement(k,i({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=N;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[p]="string"==typeof e?e:r,i[1]=o;for(var m=2;m<l;m++)i[m]=a[m];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}N.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/75e64983.d42f03f8.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[8392],{7759:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var r=n(7896),a=(n(2784),n(876));const o={sidebar_position:3,title:"Upgrading"},i=void 0,s={unversionedId:"getting-started/upgrading",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/docs/docs/getting-started/upgrading",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,title:"Upgrading"},sidebar:"defaultSidebar",previous:{title:"Getting Started",permalink:"/tools/docs/docs/getting-started/gettingstarted"},next:{title:"Requirements and Design",permalink:"/tools/docs/docs/getting-started/requirements"}},l={},p=[{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}],c={toc:p},g="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(g,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h3",{id:"cosmos-upgrades"},"COSMOS Upgrades"),(0,a.kt)("p",null,"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."),(0,a.kt)("p",null,"This example assumes an existing COSMOS project at C:\\cosmos-project."),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Stop the current COSMOS application"),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre",className:"language-batch"},"C:\\cosmos-project> openc3.bat stop\n"))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Change the release in the .env file to the desired release"),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre",className:"language-batch"},"OPENC3_TAG=5.1.1\n"))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Run the new COSMOS application"),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre",className:"language-batch"},"C:\\cosmos-project> openc3.bat run\n")))),(0,a.kt)("h3",{id:"migrating-from-cosmos-4-to-cosmos-5"},"Migrating From COSMOS 4 to COSMOS 5"),(0,a.kt)("p",null,"COSMOS 5 is a new architecture and treats targets as independent ",(0,a.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/plugins"},"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."),(0,a.kt)("p",null,"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."),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"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."),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre",className:"language-batch"},"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate -a demo\n")),(0,a.kt)("p",{parentName:"li"},"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."),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre",className:"language-batch"},"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate demo-part INST\n")),(0,a.kt)("p",{parentName:"li"},"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).")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Open the new COSMOS 5 plugin and ensure the ",(0,a.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/plugins#plugintxt-configuration-file"},"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.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Follow the ",(0,a.kt)("a",{parentName:"p",href:"/tools/docs/docs/getting-started/gettingstarted#building-your-plugin"},"building your plugin")," part of the Getting Started tutorial to build your new plugin and upload it to COSMOS 5."))))}u.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},g="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),g=p(n),d=a,m=g["".concat(l,".").concat(d)]||g[d]||u[d]||o;return n?r.createElement(m,i(i({ref:t},c),{},{components:n})):r.createElement(m,i({ref:t},c))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[g]="string"==typeof e?e:a,i[1]=s;for(var p=2;p<o;p++)i[p]=n[p];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/7efc9fb0.6164fbad.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[8324],{3314:e=>{e.exports=JSON.parse('{"title":"Guides","slug":"/guides","permalink":"/tools/docs/docs/guides","navigation":{"previous":{"title":"Telemetry Viewer","permalink":"/tools/docs/docs/tools/tlm-viewer"},"next":{"title":"Bridges","permalink":"/tools/docs/docs/guides/bridges"}}}')}}]);

data/tools/docs/assets/js/867640d5.28196e2c.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6001],{7485:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(7896),o=(n(2784),n(876));const i={title:"COSMOS and NASA cFS"},r=void 0,l={unversionedId:"guides/cfs",id:"guides/cfs",title:"COSMOS and NASA cFS",description:"Working configuration",source:"@site/docs/guides/cfs.md",sourceDirName:"guides",slug:"/guides/cfs",permalink:"/tools/docs/docs/guides/cfs",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/cfs.md",tags:[],version:"current",frontMatter:{title:"COSMOS and NASA cFS"},sidebar:"defaultSidebar",previous:{title:"Bridges",permalink:"/tools/docs/docs/guides/bridges"},next:{title:"Custom Widgets",permalink:"/tools/docs/docs/guides/custom-widgets"}},s={},c=[{value:"Working configuration",id:"working-configuration",level:2},{value:"Setting up COSMOS",id:"setting-up-cosmos",level:2},{value:"Configuring COSMOS",id:"configuring-cosmos",level:3},{value:"Setting up cFS",id:"setting-up-cfs",level:2},{value:"Clone cFS",id:"clone-cfs",level:3},{value:"Create Dockerfile in cFS dir",id:"create-dockerfile-in-cfs-dir",level:3},{value:"Build and run cFS",id:"build-and-run-cfs",level:3},{value:"Creating a COSMOS plugin for TM/TC interface with cFS",id:"creating-a-cosmos-plugin-for-tmtc-interface-with-cfs",level:2},{value:"Creating TM/TC definitions",id:"creating-tmtc-definitions",level:2},{value:"Uploading the plugin",id:"uploading-the-plugin",level:2}],p={toc:c},u="wrapper";function d(e){let{components:t,...i}=e;return(0,o.kt)(u,(0,a.Z)({},p,i,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"working-configuration"},"Working configuration"),(0,o.kt)("p",null,"This tutorial has been tested using the following components:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"COSMOS v5 release ",(0,o.kt)("a",{parentName:"li",href:"https://github.com/OpenC3/cosmos/releases/tag/v5.0.6"},"5.0.6")),(0,o.kt)("li",{parentName:"ul"},"cFS master-branch commit: 561b128 (June 1, 2022)"),(0,o.kt)("li",{parentName:"ul"},"Docker Desktop 4.9.0 on Windows")),(0,o.kt)("p",null,"Replace all ",(0,o.kt)("inlineCode",{parentName:"p"},"<xxxxxx>")," with your matching paths and names. Example: ",(0,o.kt)("inlineCode",{parentName:"p"},"<USERNAME>"),"."),(0,o.kt)("h2",{id:"setting-up-cosmos"},"Setting up COSMOS"),(0,o.kt)("p",null,"Install COSMOS according to the official ",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/getting-started/installation"},"installation")," instructions."),(0,o.kt)("h3",{id:"configuring-cosmos"},"Configuring COSMOS"),(0,o.kt)("p",null,"Change the Docker configuration for the interoperability with NASA cFS. For\nsubscribing to the telemetry, you have to append a port binding in the file\n",(0,o.kt)("inlineCode",{parentName:"p"},"compose.yaml")," under the section ",(0,o.kt)("inlineCode",{parentName:"p"},"openc3-operator"),". The port number has to\nmatch with the port number cFS is sending the telemetry on."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-yaml"},'openc3-operator:\n  ports:\n    - "1235:1235/udp"\n')),(0,o.kt)("p",null,"Run COSMOS, the first run takes a while (~15 min)."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"openc3.sh start\n")),(0,o.kt)("p",null,"When started, connect with a browser to ",(0,o.kt)("a",{parentName:"p",href:"http://localhost:2900"},"http://localhost:2900"),"."),(0,o.kt)("p",null,"For shutting down COSMOS:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"openc3.sh stop\n")),(0,o.kt)("h2",{id:"setting-up-cfs"},"Setting up cFS"),(0,o.kt)("p",null,"To run ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nasa/cFS"},"NASA cFS")," as a Docker container do the following:"),(0,o.kt)("h3",{id:"clone-cfs"},"Clone cFS"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"git clone --recurse-submodules https://github.com/nasa/cFS.git\n")),(0,o.kt)("h3",{id:"create-dockerfile-in-cfs-dir"},"Create Dockerfile in cFS dir"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-docker"},'FROM ubuntu:22.10 AS builder\n\nARG DEBIAN_FRONTEND=noninteractive\nARG SIMULATION=native\nENV SIMULATION=${SIMULATION}\nARG BUILDTYPE=debug\nENV BUILDTYPE=${BUILDTYPE}\nARG OMIT_DEPRECATED=true\nENV OMIT_DEPRECATED=${OMIT_DEPRECATED}\n\nRUN \\\n  apt-get update && \\\n  apt-get -y upgrade && \\\n  apt-get install -y build-essential git cmake && \\\n  rm -rf /var/lib/apt/lists/*\n\nWORKDIR /cFS\nCOPY . .\n\nRUN git submodule init \\\n  && git submodule update \\\n  && cp cfe/cmake/Makefile.sample Makefile \\\n  && cp -r cfe/cmake/sample_defs .\n\nRUN make prep\nRUN make\nRUN make install\n\nFROM ubuntu:22.10\nCOPY --from=builder /cFS/build /cFS/build\nWORKDIR /cFS/build/exe/cpu1\nENTRYPOINT [ "./core-cpu1" ]\n')),(0,o.kt)("h3",{id:"build-and-run-cfs"},"Build and run cFS"),(0,o.kt)("p",null,"Note we're connecting to the COSMOS network (",(0,o.kt)("inlineCode",{parentName:"p"},"docker network ls"),") and exposing the cFS ports."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"docker build -t cfs .\ndocker run --cap-add CAP_SYS_RESOURCE --net=openc3-cosmos-network --name cfs -p1234:1234 -p1235:1235 cfs\n")),(0,o.kt)("h2",{id:"creating-a-cosmos-plugin-for-tmtc-interface-with-cfs"},"Creating a COSMOS plugin for TM/TC interface with cFS"),(0,o.kt)("p",null,"The detailed instructions how to create a plugin, can be found\n",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/getting-started/gettingstarted"},"here"),', in the chapter "Interfacing with Your Hardware".'),(0,o.kt)("p",null,"Create a new plugin with the name ",(0,o.kt)("inlineCode",{parentName:"p"},"CFS"),". ",(0,o.kt)("inlineCode",{parentName:"p"},"CFS")," is the name of the plugin and\nmust be in capital letters according to the COSMOS documentation. This command\nshould create the plugin structure."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"# cd .. to the location of the cfs dir\n$PATH_TO_OPENC3/openc3.sh cli generate plugin CFS\n")),(0,o.kt)("p",null,"If you're on Linux, change the rights of this newly created plugin, because the COSMOS script\ncreates the plugin to be owned by the root user."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"sudo chown -R <USERNAME>:<USERGROUP> openc3-cfs\n")),(0,o.kt)("p",null,"In this newly created plugin, change the ",(0,o.kt)("inlineCode",{parentName:"p"},"plugin.txt")," file, so that the\ncommunication happens over UDP. ",(0,o.kt)("inlineCode",{parentName:"p"},"port_tm")," is the port number on which cFS\nsends the telemetry messages. ",(0,o.kt)("inlineCode",{parentName:"p"},"port_tc")," indicates the port on which cFS listens to the\ntelecommands."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ruby"},"VARIABLE ip 127.0.0.1\nVARIABLE port_tm 1235\nVARIABLE port_tc 1234\nVARIABLE cfs_target_name CFS\n\nTARGET CFS <%= cfs_target_name %>\n# hostname   write_dest_port   read_port   write_src_port   interface_address   ttl   write_timeout   read_timeout   bind_address\nINTERFACE <%= cfs_target_name %>_INT udp_interface.rb <%= ip %> <%= port_tc %> <%= port_tm %> nil nil 128 nil nil\n  MAP_TARGET <%= cfs_target_name %>\n")),(0,o.kt)("p",null,"Note that the two arguments to the ",(0,o.kt)("inlineCode",{parentName:"p"},"TARGET")," parameter are:"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"the physical target name that should match the name of the plugin, i.e. ",(0,o.kt)("inlineCode",{parentName:"p"},"CFS"),".\nThis name must match the folder name in the ",(0,o.kt)("inlineCode",{parentName:"p"},"targets")," folder. Example: for the\n",(0,o.kt)("inlineCode",{parentName:"p"},"CFS")," plugin, the target specifications must be under\n",(0,o.kt)("inlineCode",{parentName:"p"},"openc3-cfs/targets/CFS"),". If you don't follow this\nconvention, the server will refuse to install your plugin at the following steps.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"the name of your target and how it is shown in the user interface."))),(0,o.kt)("p",null,"In this example, we keep both names to be ",(0,o.kt)("inlineCode",{parentName:"p"},"CFS"),"."),(0,o.kt)("h2",{id:"creating-tmtc-definitions"},"Creating TM/TC definitions"),(0,o.kt)("p",null,"Change to the target folder and remove the existing files and create own files."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"cd openc3-cfs/targets/CFS/cmd_tlm\nrm *\ntouch cfs_cmds.txt\ntouch cfs_tlm.txt\ntouch to_lab_cmds.txt\n")),(0,o.kt)("p",null,"Open these newly created files in a text editor and fill them with following\ncontent."),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"to_lab_cmds.txt"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ruby"},'COMMAND CFS TO_LAB_ENABLE BIG_ENDIAN "Enable telemetry"\n  #                   NAME      BITS TYPE   min VAL     max VAL    init VAL  DESCRIPTION\n  APPEND_ID_PARAMETER STREAM_ID  16  UINT   0x1880      0x1880     0x1880    "Stream ID"\n    FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER    SEQUENCE   16  UINT   0xC000      MAX_UINT16 0xC000    ""\n    FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER    PKT_LEN    16  UINT   0x0001      0xFFFF     0x0012    "length of the packet"\n  APPEND_PARAMETER    CMD_ID      8  UINT   6           6          6         ""\n  APPEND_PARAMETER    CHECKSUM    8  UINT   MIN_UINT8   MAX_UINT8  0x98      ""\n    FORMAT_STRING "0x%2X"\n  APPEND_PARAMETER    DEST_IP   144  STRING "127.0.0.1"                      "Destination IP, i.e. 172.16.9.112, pc-57"\n')),(0,o.kt)("admonition",{title:"Enabling Telemetry",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"The command ",(0,o.kt)("inlineCode",{parentName:"p"},"0x1880")," is needed to enable telemetry. When the cFS receives\nthis command, it starts sending telemetry to the IP address provided via the\n",(0,o.kt)("inlineCode",{parentName:"p"},"DEST_IP")," field.")),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"cfs_cmds.txt"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ruby"},'COMMAND CFS NOOP BIG_ENDIAN "NOOP Command"\n  # cFS primary header\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  # cFS CMD secondary header\n  APPEND_PARAMETER       CMD_ID       8   UINT   0           0           0           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n\nCOMMAND CFS RESET BIG_ENDIAN "Reset Counters Command"\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  APPEND_PARAMETER       CMD_ID       8   UINT   1           1           1           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n\nCOMMAND CFS PROCESS BIG_ENDIAN "Process Command"\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  APPEND_PARAMETER       CMD_ID       8   UINT   2           2           2           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n')),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"cfs_tlm.txt"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ruby"},'TELEMETRY CFS HK BIG_ENDIAN "housekeeping telemetry"\n  #                NAME       BITS  TYPE    ID      DESCRIPTION\n  APPEND_ID_ITEM   STREAM_ID   16   UINT    0x0883  "Stream ID"\n    FORMAT_STRING "0x%04X"\n  APPEND_ITEM      SEQUENCE    16   UINT            "Packet Sequence"\n    FORMAT_STRING "0x%04X"\n  APPEND_ITEM      PKT_LEN     16   UINT            "Length of the packet"\n  # telemetry secondary header\n  APPEND_ITEM      SECONDS     32   UINT            ""\n        UNITS Seconds sec\n  APPEND_ITEM      SUBSECS     16   UINT            ""\n        UNITS Milliseconds ms\n  # some bytes not known for what\n  APPEND_ITEM      SPARE2ALIGN 32   UINT            "Spares"\n  # payload\n  APPEND_ITEM      CMD_ERRS     8   UINT            "Command Error Counter"\n  APPEND_ITEM      CMD_CNT      8   UINT            "Command Counter"\n  # spare / alignment\n  APPEND_ITEM      SPARE       16   UINT            "Spares"\n')),(0,o.kt)("p",null,"Build the plugin from the base of your plugin folder:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"# cd openc3-cfs\n$PATH_TO_OPENC3/openc3.sh cli rake build VERSION=1.0.0\n")),(0,o.kt)("admonition",{title:"Plugin versioning",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"Do not forget to change the version number with every build if you want to\nbetter distinguish between the versions of the plugin. When the version is\nseen in the plugin's .gem file name, it is easier to visualize the existing\nversions and the newly uploaded versions.")),(0,o.kt)("admonition",{title:"Plugin parameters",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"Multiple parameters are available for the plugin configuration. See the ",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/plugins"},"plugin")," page.")),(0,o.kt)("h2",{id:"uploading-the-plugin"},"Uploading the plugin"),(0,o.kt)("p",null,"After the plugin has been built, you can import the plugin in the admin area of\nthe page."),(0,o.kt)("p",null,"Connect with a browser to\n",(0,o.kt)("a",{parentName:"p",href:"http://localhost:2900/tools/admin"},"http://localhost:2900/tools/admin"),"."),(0,o.kt)("p",null,"Click on the clip icon and navigate to where your plugin is stored and select\nthe ",(0,o.kt)("inlineCode",{parentName:"p"},"openc3-cfs-1.0.0.xxx.gem")," file. Right of the selection line click on ",(0,o.kt)("inlineCode",{parentName:"p"},"UPLOAD"),"."),(0,o.kt)("p",null,"Determine the IP address the cFS container and COSMOS operator container are running at:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},'docker network ls\nNETWORK ID     NAME             DRIVER    SCOPE\nd842f813f1c7   openc3-cosmos-network   bridge    local\n\ndocker network inspect openc3-cosmos-network\n[\n    {\n        "Name": "openc3-cosmos-network",\n        ...\n        "Containers": {\n            "03cb6bf1b27c631fad1366e9342aeaa5b80f458a437195e4a95e674bb5f5983d": {\n                "Name": "cfs",\n                "IPv4Address": "172.20.0.9/16",\n            },\n            "ceb9ea99b00849fd8867dcd1646838fef3471f7d64b69014703dbedbcc8147fc": {\n                "Name": "openc3_openc3-operator_1",\n                "IPv4Address": "172.20.0.8/16",\n            }\n        }\n        ...\n    }\n]\n')),(0,o.kt)("p",null,"When using this plugin, make sure to change the ",(0,o.kt)("inlineCode",{parentName:"p"},"ip")," variable during uploading\nto match where cFS is running. In the example above you would set it to 172.20.0.9.\n",(0,o.kt)("inlineCode",{parentName:"p"},"port_tm")," is the port number on which cFS is sending the telemetry messages.\n",(0,o.kt)("inlineCode",{parentName:"p"},"port_tc")," indicates the port on cFS is listening for telecommands."),(0,o.kt)("p",null,"Under ",(0,o.kt)("inlineCode",{parentName:"p"},"cfs_target_name")," you can change the target name of this plugin. This\nstep is optional as long as you are fine with your plugin showing up as ",(0,o.kt)("inlineCode",{parentName:"p"},"CFS"),"."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Plugin Variable Settings",src:n(5373).Z,width:"392",height:"500"})),(0,o.kt)("admonition",{title:"Port subscription",type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"The last uploaded plugin on COSMOS will subscribe to TM on port 1235.\nOther plugins will not receive any TM anymore.")),(0,o.kt)("admonition",{title:"Typo errors",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"Presence of typos in one of the plugin files can cause problems when uploading and installing\nthe plugin's .gem file. Make sure your configuration is typo-free.")),(0,o.kt)("p",null,"In the example above, the operator image is running at 172.20.0.8. To enable telemetry, go to the browser and connect to\n",(0,o.kt)("a",{parentName:"p",href:"http://localhost:2900/tools/cmdsender/CFS/TO_LAB_ENABLE"},"http://localhost:2900/tools/cmdsender/CFS/TO_LAB_ENABLE"),". Change the ",(0,o.kt)("inlineCode",{parentName:"p"},"DEST_IP")," to the IP address of the operator image (172.20.0.8) and send the command."),(0,o.kt)("p",null,"Under ",(0,o.kt)("a",{parentName:"p",href:"http://localhost:2900/tools/cmdtlmserver/tlm-packets"},"http://localhost:2900/tools/cmdtlmserver/tlm-packets"),", you should see the incoming packets. Note in the CmdTlmServer you will also see CFS_INT UNKNOWN packets because we did not define the full cFS packet set. That exercise is left to the reader."))}d.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(2784);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,o=function(e,t){if(null==e)return{};var n,a,o={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(n),m=o,h=u["".concat(s,".").concat(m)]||u[m]||d[m]||i;return n?a.createElement(h,r(r({ref:t},p),{},{components:n})):a.createElement(h,r({ref:t},p))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,r=new Array(i);r[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:o,r[1]=l;for(var c=2;c<i;c++)r[c]=n[c];return a.createElement.apply(null,r)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},5373:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/plugin-variables-5bc00c744182c9a9591e84cb3bbb1c4deb53ff22e05f62ce1b807c26bed782e5.png"}}]);

data/tools/docs/assets/js/89e76475.5131b624.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[2093],{1159:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>a,toc:()=>s});var r=o(7896),n=(o(2784),o(876));const l={title:"Bucket Explorer"},i=void 0,a={unversionedId:"tools/bucket-explorer",id:"tools/bucket-explorer",title:"Bucket Explorer",description:"Introduction",source:"@site/docs/tools/bucket-explorer.md",sourceDirName:"tools",slug:"/tools/bucket-explorer",permalink:"/tools/docs/docs/tools/bucket-explorer",draft:!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",permalink:"/tools/docs/docs/tools/autonomic"},next:{title:"Calendar",permalink:"/tools/docs/docs/tools/calendar"}},c={},s=[{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}],p={toc:s},d="wrapper";function u(e){let{components:t,...l}=e;return(0,n.kt)(d,(0,r.Z)({},p,l,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"introduction"},"Introduction"),(0,n.kt)("p",null,"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."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Bucket Explorer",src:o(2213).Z,width:"1818",height:"1498"})),(0,n.kt)("h2",{id:"browsing-files"},"Browsing Files"),(0,n.kt)("p",null,"At the top are the three standard COSMOS buckets: ",(0,n.kt)("inlineCode",{parentName:"p"},"config"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"logs"),", and ",(0,n.kt)("inlineCode",{parentName:"p"},"tools"),". Each bucket contains top level folders named after the scope. In the Open Source edition the only scope is ",(0,n.kt)("inlineCode",{parentName:"p"},"DEFAULT"),". The ",(0,n.kt)("inlineCode",{parentName:"p"},"config")," bucket holds the COSMOS configuration which is populated as plugins are installed. The ",(0,n.kt)("inlineCode",{parentName:"p"},"logs")," bucket holds the COSMOS logs which are generated by the various COSMOS microservices. These logs are gzipped to save storage space. The ",(0,n.kt)("inlineCode",{parentName:"p"},"tools")," bucket holds the source code for the built-in COSMOS tools as well as user create 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."),(0,n.kt)("h3",{id:"upload"},"Upload"),(0,n.kt)("p",null,"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,n.kt)("a",{parentName:"p",href:"https://openc3.com/enterprise"},"COSMOS Enterprise")," you can only upload files to the config/DEFAULT/targets_modified folder unless you're an Admin."),(0,n.kt)("h3",{id:"download"},"Download"),(0,n.kt)("p",null,"Click the Download icon to download any of the individual files from any bucket and path."),(0,n.kt)("h3",{id:"delete"},"Delete"),(0,n.kt)("p",null,"Click the Trash icon to delete an individual file. Note that in ",(0,n.kt)("a",{parentName:"p",href:"https://openc3.com/enterprise"},"COSMOS Enterprise")," you can only delete files in the config/DEFAULT/targets_modified folder unless you're an Admin."))}u.isMDXComponent=!0},876:(e,t,o)=>{o.d(t,{Zo:()=>p,kt:()=>h});var r=o(2784);function n(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function l(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,r)}return o}function i(e){for(var t=1;t<arguments.length;t++){var o=null!=arguments[t]?arguments[t]:{};t%2?l(Object(o),!0).forEach((function(t){n(e,t,o[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(o)):l(Object(o)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(o,t))}))}return e}function a(e,t){if(null==e)return{};var o,r,n=function(e,t){if(null==e)return{};var o,r,n={},l=Object.keys(e);for(r=0;r<l.length;r++)o=l[r],t.indexOf(o)>=0||(n[o]=e[o]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r<l.length;r++)o=l[r],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(n[o]=e[o])}return n}var c=r.createContext({}),s=function(e){var t=r.useContext(c),o=t;return e&&(o="function"==typeof e?e(t):i(i({},t),e)),o},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var o=e.components,n=e.mdxType,l=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),d=s(o),f=n,h=d["".concat(c,".").concat(f)]||d[f]||u[f]||l;return o?r.createElement(h,i(i({ref:t},p),{},{components:o})):r.createElement(h,i({ref:t},p))}));function h(e,t){var o=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=o.length,i=new Array(l);i[0]=f;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a[d]="string"==typeof e?e:n,i[1]=a;for(var s=2;s<l;s++)i[s]=o[s];return r.createElement.apply(null,i)}return r.createElement.apply(null,o)}f.displayName="MDXCreateElement"},2213:(e,t,o)=>{o.d(t,{Z:()=>r});const r=o.p+"assets/images/bucket_explorer-983c087ee3bdcf8626219e782620b6c580fd82bfe2e8b0c662a0f90cdca43838.png"}}]);