openc3-cosmos-tool-docs 6.4.1 → 6.4.2

data/tools/staticdocs/assets/js/696b4199.1c205c60.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["9880"],{2840:function(e,t,i){i.d(t,{Z:()=>a,a:()=>o});var n=i(2784);let r={},s=n.createContext(r);function o(e){let t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(s.Provider,{value:t},e.children)}},8983:function(e,t,i){i.r(t),i.d(t,{frontMatter:()=>o,default:()=>d,contentTitle:()=>a,assets:()=>c,toc:()=>l,metadata:()=>n});var n=JSON.parse('{"id":"configuration/ssl-tls","title":"SSL-TLS","description":"How to configure SSL and TLS","source":"@site/docs/configuration/ssl-tls.md","sourceDirName":"configuration","slug":"/configuration/ssl-tls","permalink":"/tools/staticdocs/docs/configuration/ssl-tls","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/ssl-tls.md","tags":[],"version":"current","sidebarPosition":12,"frontMatter":{"sidebar_position":12,"title":"SSL-TLS","description":"How to configure SSL and TLS","sidebar_custom_props":{"myEmoji":"\uD83D\uDD10"}},"sidebar":"defaultSidebar","previous":{"title":"Screens","permalink":"/tools/staticdocs/docs/configuration/telemetry-screens"},"next":{"title":"Tools","permalink":"/tools/staticdocs/docs/tools"}}'),r=i(2322),s=i(2840);let o={sidebar_position:12,title:"SSL-TLS",description:"How to configure SSL and TLS",sidebar_custom_props:{myEmoji:"\uD83D\uDD10"}},a=void 0,c={},l=[{value:"Understanding SSL, TLS, and Public Key Infrastructure (PKI)",id:"understanding-ssl-tls-and-public-key-infrastructure-pki",level:2},{value:"Configure COSMOS for TLS",id:"configure-cosmos-for-tls",level:2},{value:"Obtain or Generate the Certificates",id:"obtain-or-generate-the-certificates",level:3},{value:"Configuring cacert.pem for your certificate authority",id:"configuring-cacertpem-for-your-certificate-authority",level:3},{value:"Configure COSMOS for TLS when running in Docker Compose",id:"configure-cosmos-for-tls-when-running-in-docker-compose",level:3},{value:"Enterprise Changes required for all TLS configurations",id:"enterprise-changes-required-for-all-tls-configurations",level:4},{value:"Using TLS and your own certificates",id:"using-tls-and-your-own-certificates",level:4},{value:"Using a global certificate from Let's Encrypt",id:"using-a-global-certificate-from-lets-encrypt",level:4},{value:"Configure COSMOS Enterprise for TLS when running in Kubernetes",id:"configure-cosmos-enterprise-for-tls-when-running-in-kubernetes",level:3}];function h(e){let t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:["OpenC3 COSMOS 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,r.jsx)(t.a,{href:"https://doc.traefik.io/traefik/routing/entrypoints/#tls",children:"docs"}),"."]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Docker Security Diagram",src:i(9910).Z+"",width:"803",height:"743"})}),"\n",(0,r.jsx)(t.h2,{id:"understanding-ssl-tls-and-public-key-infrastructure-pki",children:"Understanding SSL, TLS, and Public Key Infrastructure (PKI)"}),"\n",(0,r.jsx)(t.p,{children:"Security on the internet is built on the technologies SSL and TLS. SSL (Secure Sockets Layer) was the original version but is now an outdated technology that is no longer used in favor of the more modern TLS (Transport Layer Security). However, the terms SSL and TLS are still used interchangeably in most conversations. Public Key Infrastructure (PKI) is what makes secure sockets like SSL and TLS work - and is built around certificates, certificate authorities, and public key encryption."}),"\n",(0,r.jsx)(t.p,{children:'Public key encryption works with a set of two keys: the public key and the private key. A message encrypted with the public key can only be decrypted by the holder of the private key. This allows for secure messaging in one direction (from anyone with the public key to the single holder of the private key). Public keys can be safely shared "publicly" because they are only useful for creating an encrypted document that is useless to anyone without the private key. The private key should never be shared. Technically, the private key can also be used to encrypt messages that can be decrypted by the public key, but this is not useful since the public key is assumed to be available to everyone.'}),"\n",(0,r.jsx)(t.p,{children:"Certificate authorities issue certificates which contain a public key and additional information such as a domain name and are then digitally signed by the certificate authority. Verifying that the digital signature is valid (from a trusted certificate authority) is how your computer knows that if the public key works with a given domain name, then it can be trusted that the computer responding to that domain name is who it says it is. This can only be done if your computer has the information it needs to know if the certificate is valid. This information is included in the certificate authority trust store on your computer."}),"\n",(0,r.jsx)(t.p,{children:"Have you ever seen \"self signed certificate\" type error messages? These error messages mean that your computer's certificate authority trust store wasn't able to verify the signature on a certificate. Generally this is because the certificate was issued by a private certificate authority (like an Active Directory Server or other company specific issuer). Computers by default include the information they need to check certificates from major public issuers of certificates (like Let's Encrypt) but don't have any information on private issuers unless you set it up."}),"\n",(0,r.jsx)(t.p,{children:"Does this mean we can't use TLS without paying for certificates (or using free services like Let's Encrypt)? No, but it does mean if you use a private certificate authority, there is more work involved to make it work so that your computer will trust the certificates. This is unavoidable because computers are setup to not trust unknown certificate authorities for a good reason. If you trust all certificates then anyone can pretend to be any domain name on the internet. Side note: Domain Name Service (DNS) is still another layer of protection but TLS prevents someone who hacks DNS from also pretending to be valid domains."}),"\n",(0,r.jsx)(t.h2,{id:"configure-cosmos-for-tls",children:"Configure COSMOS for TLS"}),"\n",(0,r.jsx)(t.h3,{id:"obtain-or-generate-the-certificates",children:"Obtain or Generate the Certificates"}),"\n",(0,r.jsx)(t.p,{children:'Most OpenC3 customers will be using certificates generated by a private certificate authority. If your certificate authority is controlled by your IT department please contact them to receive the public key/private key and full certificate chain (cacert.pem) file for your domain name. Note that you must have the full certificate chain. Often CAs are "chained" with a root CA and one or more intermediate CAs. You must have the certificates for each in your cacert.pem or it will not work.'}),"\n",(0,r.jsx)(t.p,{children:"If using a cloud service, like AWS Private CA, follow the service's directions to retrieve these three files."}),"\n",(0,r.jsx)(t.p,{children:"If you are running COSMOS on an internet facing server (not recommended), then you can get free TLS certificates from Let's Encrypt. In this case the Traefik container will retrieve the certificates for you automatically (directions later on this page)."}),"\n",(0,r.jsx)(t.p,{children:"If you want to generate self-signed certificates, especially for an IP address rather than a domain name, we recommend using the mkcert utility."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Install mkcert (brew install mkcert on MacOs)"}),"\n",(0,r.jsx)(t.li,{children:"mkcert -install"}),"\n",(0,r.jsx)(t.li,{children:'mkcert "your ip or domain name here"'}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"This will generate YOURDOMAIN.pem (public key) and YOURDOMAIN-key.pem (private key)"}),"\n",(0,r.jsx)(t.h3,{id:"configuring-cacertpem-for-your-certificate-authority",children:"Configuring cacert.pem for your certificate authority"}),"\n",(0,r.jsxs)(t.p,{children:["If you are using certificates from a public certificate authority then you are good to go. We build all of our containers with a recent cacert.pem file that comes from the curl project and can be downloaded here: ",(0,r.jsx)(t.a,{href:"https://curl.se/ca/cacert.pem",children:"https://curl.se/ca/cacert.pem"}),". This file contains the information needed to verify certificates from all of the major public certificate authorities. You can safely skip ahead to configuring COSMOS with the TLS public/private keys."]}),"\n",(0,r.jsx)(t.p,{children:"However, if your certificates are coming from a private certificate authority then you will need to configure the COSMOS containers with a cacert.pem file that includes the necessary information from your private certificate authority. Note that all non-public certificate authorities will need to be configured including services like Amazon Private CA. COSMOS WILL NOT WORK WITHOUT FOLLOWING THIS STEP."}),"\n",(0,r.jsx)(t.p,{children:"It is recommended that you append your private certificate authority certificate to the end of the provided cacert.pem file. This allows COSMOS to work with the private CA and with the public internet over TLS."}),"\n",(0,r.jsx)(t.p,{children:"In general this can be done like this:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:"cat myca.pem >> cacert.pem\n"})}),"\n",(0,r.jsx)(t.p,{children:"If using mkcert to create self signed certificates, this can be done as follows:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:'cat "`mkcert -CAROOT`"/rootCA.pem >> cacert.pem\n'})}),"\n",(0,r.jsx)(t.p,{children:"In all versions of COSMOS the base cacert.pem file can be found at the root of your COSMOS folder structure. This is the file you should modify/replace with your CA information."}),"\n",(0,r.jsx)(t.h3,{id:"configure-cosmos-for-tls-when-running-in-docker-compose",children:"Configure COSMOS for TLS when running in Docker Compose"}),"\n",(0,r.jsx)(t.p,{children:"Note: These instructions are only for Docker Compose (Both Core and Enterprise). If you are using Kubernetes with COSMOS Enterprise please see the Kubernetes instructions."}),"\n",(0,r.jsx)(t.p,{children:"Follow earlier instructions to obtain your private key, public key, and to modify cacert.pem as necessary."}),"\n",(0,r.jsx)(t.h4,{id:"enterprise-changes-required-for-all-tls-configurations",children:"Enterprise Changes required for all TLS configurations"}),"\n",(0,r.jsx)(t.p,{children:"If running COSMOS Core skip to the next section."}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Edit compose.yaml","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:['Change this openc3-keycloak line: KC_HOSTNAME: "',(0,r.jsx)(t.a,{href:"http://localhost:2900/auth",children:"http://localhost:2900/auth"}),'"']}),"\n",(0,r.jsx)(t.li,{children:"It should be changed to the final url with correct http/https, domain, port and end with /auth"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Edit .env","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Change the OPENC3_KEYCLOAK_EXTERNAL_URL and OPENC3_KEYCLOAK_URL lines so that ",(0,r.jsx)(t.strong,{children:"both"})," are set to the exact same url as set above in compose.yaml"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Edit openc3-enterprise-grafana/cosmos.yaml","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Change the cosmosUrl and keycloakUrl settings to the correct schema, domain, and port. Keep /auth if present."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Edit openc3-enterprise-grafana/grafana.ini","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Change the root_url, auth_url, token_url, and api_url settings to the correct schema, domain, and port, leave any additional path information."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"using-tls-and-your-own-certificates",children:"Using TLS and your own certificates"}),"\n",(0,r.jsx)(t.p,{children:'The following steps are written for the enterprise folder names. Remove "-enterprise" for COSMOS Core.'}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Copy your public SSL certificate to ./openc3-enterprise-traefik/cert.crt"}),"\n",(0,r.jsx)(t.li,{children:"Copy your private SSL certificate to ./openc3-enterprise-traefik/cert.key"}),"\n",(0,r.jsxs)(t.li,{children:["Edit compose.yaml","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Comment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/traefik.yaml:/etc/traefik/traefik.yaml:z"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/traefik-ssl.yaml:/etc/traefik/traefik.yaml"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/cert.key:/etc/traefik/cert.key"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/cert.crt:/etc/traefik/cert.crt"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Modify this openc3-traefik line to remove the ip address and modify the first port number if desired ",(0,r.jsx)(t.strong,{children:"(Note: leave the last :2900)"}),": ",(0,r.jsx)(t.code,{children:'- "127.0.0.1:2900:2900"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Modify this openc3-traefik line to remove the ip address and modify the first port number if desired ",(0,r.jsx)(t.strong,{children:"(Note: leave the last :2943)"}),": ",(0,r.jsx)(t.code,{children:'- "127.0.0.1:2943:2943"'})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Edit ./openc3-enterprise-traefik/traefik-ssl.yaml","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:'Update line 22 to your domain: - main: "mydomain.com" # Update with your domain'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Start COSMOS","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"On Linux/Mac: ./openc3.sh run"}),"\n",(0,r.jsx)(t.li,{children:"On Windows: openc3.bat run"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Enterprise Only: After approximately 2 minutes, open a web browser to ",(0,r.jsx)(t.a,{href:"https://mydomain.com/auth/",children:"https://mydomain.com/auth/"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:'If you run "docker ps", you can watch until the openc3-cosmos-enterprise-init container completes, at which point the system should be fully configured and ready to use.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Enterprise Only: ",(0,r.jsx)(t.strong,{children:"IMPORTANT"}),": You must configure Keycloak before accessing ",(0,r.jsx)(t.a,{href:"https://mydomain.com",children:"https://mydomain.com"})," to get to the main COSMOS app and Grafana to work (you'll just see a solid color page until you do this) - Please follow the Keycloak documentation in our ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-enterprise/blob/main/docs/OpenC3%20COSMOS%20Enterprise%20User's%20Manual.pdf",children:"User's Manual"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"using-a-global-certificate-from-lets-encrypt",children:"Using a global certificate from Let's Encrypt"}),"\n",(0,r.jsx)(t.p,{children:"Warning: These directions only work when exposing OpenC3 COSMOS to the internet. Make sure you understand the risks and have properly configured your server settings and firewall."}),"\n",(0,r.jsx)(t.p,{children:'The following steps are written for the enterprise folder names. Remove "-enterprise" for COSMOS Core.'}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"Make sure that your public DNS settings are mapping your domain name to your server"}),"\n",(0,r.jsxs)(t.li,{children:["Edit compose.yaml","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsxs)(t.li,{children:["Comment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/traefik.yaml:/etc/traefik/traefik.yaml:z"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "./openc3-enterprise-traefik/traefik-letsencrypt.yaml:/etc/traefik/traefik.yaml"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Comment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "127.0.0.1:2900:2900"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Comment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "127.0.0.1:2943:2943"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "80:2900"'})]}),"\n",(0,r.jsxs)(t.li,{children:["Uncomment out this openc3-traefik line: ",(0,r.jsx)(t.code,{children:'- "443:2943"'})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Start COSMOS","\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:"On Linux/Mac: ./openc3.sh run"}),"\n",(0,r.jsx)(t.li,{children:"On Windows: openc3.bat run"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Enterprise Only: After approximately 2 minutes, open a web browser to ",(0,r.jsx)(t.a,{href:"https://mydomain.com/auth/",children:"https://mydomain.com/auth/"}),"\n",(0,r.jsxs)(t.ol,{children:["\n",(0,r.jsx)(t.li,{children:'If you run "docker ps", you can watch until the openc3-cosmos-enterprise-init container completes, at which point the system should be fully configured and ready to use.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["Enterprise Only: ",(0,r.jsx)(t.strong,{children:"IMPORTANT"}),": You must configure Keycloak before accessing ",(0,r.jsx)(t.a,{href:"https://mydomain.com",children:"https://mydomain.com"})," to get to the main COSMOS app and Grafana to work (you'll just see a blank blue page until you do this) - Please follow the Keycloak documentation in our ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-enterprise/blob/main/docs/OpenC3%20COSMOS%20Enterprise%20User's%20Manual.pdf",children:"User's Manual"})]}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"configure-cosmos-enterprise-for-tls-when-running-in-kubernetes",children:"Configure COSMOS Enterprise for TLS when running in Kubernetes"}),"\n",(0,r.jsx)(t.p,{children:"Follow earlier instructions to obtain your private key, public key, and to modify cacert.pem as necessary."}),"\n",(0,r.jsx)(t.p,{children:"In most Kubernetes environments, COSMOS will use a separate platform provided load balancer as the TLS termination point. Follow the directions for your specific Kubernetes environment to configure this load balancer with the TLS keys. Don't forget to update the cacert.pem file for COSMOS (and create the secret defined below) so that COSMOS can recognize the CA that issued your keys. As of COSMOS Enterprise 6.4, the create_secrets.sh script will create a secret called openc3-cacert to hold this file. This file is automatically mounted into each container that needs it at /devel/cacert.pem. Our helm charts also set the appropriate environment variables to use this file."}),"\n",(0,r.jsx)(t.p,{children:"You will also need to correctly set several values in the helm chart values.yaml file to configure for TLS. The relevant values are described in the following table."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Value Name"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Default Value"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"global.cosmosdomain"}),(0,r.jsx)(t.td,{children:"The domain name that cosmos will be hosted at"}),(0,r.jsx)(t.td,{children:"cosmos.openc3.com"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"ssl"}),(0,r.jsx)(t.td,{children:"This flag should be set to true if you are using SSL/TLS even with an external load balancer"}),(0,r.jsx)(t.td,{children:"true"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"traefik.tlsCerts"}),(0,r.jsx)(t.td,{children:"Set this flag to true if you are going to use Traefik as your SSL endpoint with given certs"}),(0,r.jsx)(t.td,{children:"false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"traefik.letsEncrypt"}),(0,r.jsx)(t.td,{children:"Set this flag to true if you want Traefik to acquire certs from Lets Encrypt. Will only work on the public internet."}),(0,r.jsx)(t.td,{children:"false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"traefik.letsEncryptEmail"}),(0,r.jsx)(t.td,{children:"Email address given to Lets Encrypt when issuing certs"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Additionally the following secrets will need to be defined based on how you set the above values."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Secret Name"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"openc3-cacert"}),(0,r.jsx)(t.td,{children:"This should always be set with the cacert.pem file used by COSMOS (even if just using public certificates). Be sure to append the full certificate chain from your private CA so that COSMOS can verify certificates successfully. Without doing this you will be guaranteed to receive SSL errors."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"openc3-traefik-cert"}),(0,r.jsx)(t.td,{children:"Public key provided to Traefik if traefik.tlsCerts is true. Should be created with the filename as cert.crt. ie. kubectl create secret generic openc3-traefik-cert --from-file=cert.crt=/Users/ryanmelt/192.168.1.109.pem"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"openc3-traefik-key"}),(0,r.jsx)(t.td,{children:"Private key provided to Traefik if traefik.tlsCerts is true. Should be created with the filename as cert.key. ie. kubectl create secret generic openc3-traefik-cert --from-file=cert.key=/Users/ryanmelt/192.168.1.109-key.pem"})]})]})]})]})}function d(e={}){let{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},9910:function(e,t,i){i.d(t,{Z:()=>n});let n=i.p+"assets/images/docker-security-bb6d4bdd60a5cd7df87a572159c6369b67bee5735be5a501b25786cabdcd4228.png"}}]);

data/tools/staticdocs/assets/js/6b210247.32ded6d5.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["3041"],{2840:function(e,t,r){r.d(t,{Z:()=>l,a:()=>d});var s=r(2784);let i={},n=s.createContext(i);function d(e){let t=s.useContext(n);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(n.Provider,{value:t},e.children)}},763:function(e,t,r){r.r(t),r.d(t,{frontMatter:()=>d,default:()=>o,contentTitle:()=>l,assets:()=>a,toc:()=>c,metadata:()=>s});var s=JSON.parse('{"id":"getting-started/requirements","title":"Requirements and Design","description":"COSMOS Requirements and Design","source":"@site/docs/getting-started/requirements.md","sourceDirName":"getting-started","slug":"/getting-started/requirements","permalink":"/tools/staticdocs/docs/getting-started/requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/requirements.md","tags":[],"version":"current","sidebarPosition":8,"frontMatter":{"sidebar_position":8,"title":"Requirements and Design","description":"COSMOS Requirements and Design","sidebar_custom_props":{"myEmoji":"\uD83D\uDCD1"}},"sidebar":"defaultSidebar","previous":{"title":"Podman","permalink":"/tools/staticdocs/docs/getting-started/podman"},"next":{"title":"Configuration","permalink":"/tools/staticdocs/docs/configuration"}}'),i=r(2322),n=r(2840);let d={sidebar_position:8,title:"Requirements and Design",description:"COSMOS Requirements and Design",sidebar_custom_props:{myEmoji:"\uD83D\uDCD1"}},l=void 0,a={},c=[{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}];function h(e){let t={h2:"h2",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsx)(t.p,{children:"COSMOS is currently made up of the following applications:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Command and Telemetry Server"})," - Provides status of realtime commanding, telemetry reception, logging, limits monitoring, and packet routing."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Limits Monitor"})," - Monitors telemetry with defined limits and shows items that currently are or have violated limits."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Command Sender"})," - Provides a graphical interface for manually sending individual commands."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Script Runner"})," - Executes scripts and provides highlighting of the currently executing line. Now also includes TestRunner functionality."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Packet Viewer"})," - Provides realtime visualization of every telemetry packet that has been defined."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Telemetry Viewer"})," - Provides custom telemetry screen functionality with advanced layout and visualization widgets."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Telemetry Grapher"})," - Provides realtime and offline graphing of telemetry data."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Data Extractor"})," - Extracts telemetry and command packet log files into CSV data."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Data Viewer"})," - Provides text based telemetry visualization for items."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Bucket Explorer"})," - Browse the COSMOS bucket storage in any cloud environment."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Table Manager"})," - Binary file editor with Script Runner integration for upload / download."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Handbooks"})," - Generate html page of the command and telemetry definitions."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Calendar"})," - Provides scheduling of commands and scripts. Also provides a framework for reserving resources."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Admin"})," - Provides an administrative interface to COSMOS."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsx)(t.h2,{id:"terminology",children:"Terminology"}),"\n",(0,i.jsx)(t.p,{children:"The COSMOS system uses several terms that are important to understand. The following table defines these terms."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Term"}),(0,i.jsx)(t.th,{children:"Definition"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Target"}),(0,i.jsx)(t.td,{children:"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,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Command"}),(0,i.jsx)(t.td,{children:"A packet of information telling a target to perform an action of some sort."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Telemetry Packet"}),(0,i.jsx)(t.td,{children:"A packet of information providing status from a target."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Interface"}),(0,i.jsx)(t.td,{children:"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,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Ruby"}),(0,i.jsx)(t.td,{children:"The powerful dynamic programming language used to write the COSMOS applications and libraries as well as COSMOS scripts and test procedures."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Configuration Files"}),(0,i.jsx)(t.td,{children:"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,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Packet Log Files"}),(0,i.jsx)(t.td,{children:"Binary files containing either logged commands or telemetry packets."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Message Log Files"}),(0,i.jsx)(t.td,{children:"Text files containing messages generated by the system."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Tool"}),(0,i.jsx)(t.td,{children:"Another name for a COSMOS application."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"overall-architecture-and-context-diagram",children:"Overall Architecture and Context Diagram"}),"\n",(0,i.jsx)(t.p,{children:"The following diagram shows the current COSMOS architecture."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"COSMOS Architecture",src:r(854).Z+"",width:"1155",height:"538"})}),"\n",(0,i.jsx)(t.p,{children:"Key aspects of this architecture:"}),"\n",(0,i.jsx)(t.p,{children:"Starting with the release of version 5, COSMOS 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."}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"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."}),"\n",(0,i.jsx)(t.li,{children:"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."}),"\n",(0,i.jsx)(t.li,{children:"All realtime communication with targets flows through the COSMOS system. This ensures all commands and telemetry are logged."}),"\n",(0,i.jsx)(t.li,{children:"Every tool is configured with plain text configuration files."}),"\n",(0,i.jsx)(t.li,{children:"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."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"overall-requirements",children:"Overall Requirements"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-1"}),(0,i.jsx)(t.td,{children:"All COSMOS core functionality shall be containerized."}),(0,i.jsx)(t.td,{children:"Verify COSMOS is running in Docker"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-2"}),(0,i.jsx)(t.td,{children:"The COSMOS user interface shall be accessible from Chromium based web browsers"}),(0,i.jsx)(t.td,{children:"Open COSMOS in Chrome/Edge"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-3"}),(0,i.jsx)(t.td,{children:"The COSMOS user interface shall be accessible from the Firefox web browser"}),(0,i.jsx)(t.td,{children:"Open COSMOS in Firefox"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-4"}),(0,i.jsx)(t.td,{children:"COSMOS shall log all commands sent"}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-5"}),(0,i.jsx)(t.td,{children:"COSMOS shall log all telemetry received"}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-6"}),(0,i.jsx)(t.td,{children:"COSMOS shall decommutate all telemetry packets received"}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-7"}),(0,i.jsx)(t.td,{children:"COSMOS shall support autonomously attempting to connect to targets."}),(0,i.jsx)(t.td,{children:"Verify targets are connected upon starting the CTS."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-8"}),(0,i.jsx)(t.td,{children:"COSMOS shall time stamp telemetry packets upon receipt."}),(0,i.jsx)(t.td,{children:"Verify logged packets are timestamped."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-9"}),(0,i.jsx)(t.td,{children:"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,i.jsx)(t.td,{children:"View time stamps in log."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-10"}),(0,i.jsx)(t.td,{children:"COSMOS shall time stamp received telemetry with a UTC timestamp."}),(0,i.jsx)(t.td,{children:"Verify logged time stamps are as expected."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"COSMOS-11"}),(0,i.jsx)(t.td,{children:"COSMOS shall maintain a timestamped log of commands received, limits violations, and errors encountered."}),(0,i.jsx)(t.td,{children:"View COSMOS message log."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"api-requirements",children:"Api Requirements"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-1"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow scripted connection and disconnection of interfaces."}),(0,i.jsx)(t.td,{children:"Disconnect and connect an interface from a script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-2"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow scripted connection and disconnection of routers."}),(0,i.jsx)(t.td,{children:"Disconnect and connect a router from a script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-3"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow scripted setting of the current limits set."}),(0,i.jsx)(t.td,{children:"Select a different limits set from a script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-4"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow commanding of targets"}),(0,i.jsx)(t.td,{children:"Send a command"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-5"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow reading the current value of any telemetry item"}),(0,i.jsx)(t.td,{children:"Read a telemetry point"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-6"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow streaming realtime and logged telemetry packets"}),(0,i.jsx)(t.td,{children:"Stream telemetry packets"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-7"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow streaming realtime and logged command packets"}),(0,i.jsx)(t.td,{children:"Stream command packets"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"API-8"}),(0,i.jsx)(t.td,{children:"The COSMOS API shall allow starting COSMOS scripts"}),(0,i.jsx)(t.td,{children:"Start a script using the API"})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"command-and-telemetry-server",children:"Command and Telemetry Server"}),"\n",(0,i.jsx)(t.p,{children:"The Command and Telemetry server provides status on the the overall COSMOS installation for a specific scope."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-1"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display a list of all interfaces."}),(0,i.jsx)(t.td,{children:"View the Interfaces tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-2"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall allow manual connection and disconnection of interfaces."}),(0,i.jsx)(t.td,{children:"Press a GUI button to disconnect and connect an interface."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-3"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display a list of all targets."}),(0,i.jsx)(t.td,{children:"View the Targets tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-4"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display a list of known commands."}),(0,i.jsx)(t.td,{children:"View the Cmd Packets tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-5"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display raw command data for the most recent command received."}),(0,i.jsx)(t.td,{children:"View the Cmd Packets tab and click the View Raw button for a command."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-6"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display a list of known telemetry packets."}),(0,i.jsx)(t.td,{children:"View the Tlm Packets tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-7"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display raw telemetry packet data for the most recent telemetry packet received."}),(0,i.jsx)(t.td,{children:"View the Tlm Packets tab and click the View Raw button for a telemetry packet."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-8"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display a list of all routers."}),(0,i.jsx)(t.td,{children:"View the Routers tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-9"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall allow manual connection and disconnection of routers."}),(0,i.jsx)(t.td,{children:"Press a GUI button to disconnect and connect a router."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-10"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall allow manually setting the current limits set."}),(0,i.jsx)(t.td,{children:"Select a different limits set from the combobox."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-11"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall support opening telemetry packets in Packet Viewer."}),(0,i.jsx)(t.td,{children:"On the Tlm Packets tab click View in Packet Viewer for a telemetry packet."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CTS-12"}),(0,i.jsx)(t.td,{children:"The Command and Telemetry Server shall display time stamps in local time."}),(0,i.jsx)(t.td,{children:"View time stamps in log."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"limits-monitor",children:"Limits Monitor"}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-1"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall display all telemetry points currently out of limits."}),(0,i.jsx)(t.td,{children:"View displayed telemetry points."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-2"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall support ignoring telemetry points."}),(0,i.jsx)(t.td,{children:"Click ignore on a telemetry point."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-3"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall keep a displayed log of limits violations."}),(0,i.jsx)(t.td,{children:"View the log tab."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-4"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall continue displaying a telemetry point that temporarily went out of limits."}),(0,i.jsx)(t.td,{children:"Watch until a telemetry points returns to green."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-5"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall support saving its configuration."}),(0,i.jsx)(t.td,{children:"Save the configuration."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LM-6"}),(0,i.jsx)(t.td,{children:"Limits Monitor shall support loading its configuration."}),(0,i.jsx)(t.td,{children:"Load the configuration."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"command-sender",children:"Command Sender"}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-1"}),(0,i.jsx)(t.td,{children:"Command Sender shall allow selection of a command by target name and packet name."}),(0,i.jsx)(t.td,{children:"Select a specific command by target name and packet name in the drop down menus."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-2"}),(0,i.jsx)(t.td,{children:"Command Sender shall allow sending the selected command."}),(0,i.jsx)(t.td,{children:"Send the selected command by pressing the Send button."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-3"}),(0,i.jsx)(t.td,{children:"Command Sender shall display non-ignored parameters for the selected command."}),(0,i.jsx)(t.td,{children:"Select a specific command and verify the expected parameters are shown."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-4"}),(0,i.jsx)(t.td,{children:"Command Sender shall provide a mechanism to select state values for command parameters with states."}),(0,i.jsx)(t.td,{children:"Select a specific state value for a specific command with states."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-5"}),(0,i.jsx)(t.td,{children:"Command Sender shall allow sending a manually entered value for a command parameter with states."}),(0,i.jsx)(t.td,{children:"Manually enter a value for a specific command with states."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-6"}),(0,i.jsx)(t.td,{children:"Command Sender shall refuse to send commands if required parameters are not provided."}),(0,i.jsx)(t.td,{children:"Attempt to send a command with a required parameter not filled out."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-7"}),(0,i.jsx)(t.td,{children:"Command Sender shall support sending commands while ignoring range checking."}),(0,i.jsx)(t.td,{children:"Enter Ignore Range Checking mode and then send a command with an out of range parameter."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-8"}),(0,i.jsx)(t.td,{children:"Command Sender shall optionally display state values in hex."}),(0,i.jsx)(t.td,{children:'Enter "Display State Values in Hex" mode and verify state values are displayed as hex.'})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-9"}),(0,i.jsx)(t.td,{children:"Command Sender shall optionally display ignored command parameters."}),(0,i.jsx)(t.td,{children:'Enter "Show Ignored Parameters" mode and verify ignored parameters are displayed.'})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-10"}),(0,i.jsx)(t.td,{children:"Command Sender shall respect hazardous commands and notify the user before proceeding."}),(0,i.jsx)(t.td,{children:"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,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-11"}),(0,i.jsx)(t.td,{children:"Command Sender shall keep a command history of each command sent."}),(0,i.jsx)(t.td,{children:"Send a command and verify that it shows up in the command history box."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"CMD-12"}),(0,i.jsx)(t.td,{children:"Command Sender shall allow resending of any command in the command history."}),(0,i.jsx)(t.td,{children:"Resend one of the commands in the command history box."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"script-runner",children:"Script Runner"}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-1"}),(0,i.jsx)(t.td,{children:"Script Runner shall provide a text editor for developing test scripts."}),(0,i.jsx)(t.td,{children:"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,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-2"}),(0,i.jsx)(t.td,{children:"Script Runner shall provide search and replace functionality."}),(0,i.jsx)(t.td,{children:"Perform all standard search and replace functionality, including search, replace, find next, and find previous."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-3"}),(0,i.jsx)(t.td,{children:"Script Runner shall provide code completion for cmd(), tlm(), and wait_check() COSMOS API methods. Note: Other methods may also be supported."}),(0,i.jsx)(t.td,{children:"Create a script and exercise code completion on the mentioned keywords."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-4"}),(0,i.jsx)(t.td,{children:"Script Runner shall execute Ruby-based COSMOS scripts."}),(0,i.jsx)(t.td,{children:"Press start and execute a script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-5"}),(0,i.jsx)(t.td,{children:"Script Runner shall highlight the currently executing line of the script."}),(0,i.jsx)(t.td,{children:"Verify that lines are highlighted as a test script executes."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-6"}),(0,i.jsx)(t.td,{children:"Script Runner shall allow pausing an executing script."}),(0,i.jsx)(t.td,{children:"Press pause button and verify script is paused. Press start to resume."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-7"}),(0,i.jsx)(t.td,{children:"Script Runner shall allow stopping an executing script."}),(0,i.jsx)(t.td,{children:"Press stop and verify script stops."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-8"}),(0,i.jsx)(t.td,{children:"Script Runner shall pause an executing script upon the occurrence of an error."}),(0,i.jsx)(t.td,{children:"Create a script with a statement that is guaranteed to fail and verify that the script is paused."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-9"}),(0,i.jsx)(t.td,{children:"Script Runner shall log commands sent."}),(0,i.jsx)(t.td,{children:"Execute a script that sends a command and verify it is logged."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-10"}),(0,i.jsx)(t.td,{children:"Script Runner shall log text written to STDOUT. Note: Typically through the puts method."}),(0,i.jsx)(t.td,{children:"Execute a script that uses puts to write a message and verify it is logged."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-11"}),(0,i.jsx)(t.td,{children:"Script Runner shall log wait times."}),(0,i.jsx)(t.td,{children:"Execute a script that includes a wait method and verify wait time is logged."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-12"}),(0,i.jsx)(t.td,{children:"Script Runner shall log errors that occur while the script is executing."}),(0,i.jsx)(t.td,{children:"Create a script with a check statement that is guaranteed to fail and verify it is logged."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-13"}),(0,i.jsx)(t.td,{children:"Script Runner shall log check statement success and failure."}),(0,i.jsx)(t.td,{children:"Create a script with a check statement that is guaranteed to fail and one that is guaranteed to succeed. Verify both the success and failure are logged."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-14"}),(0,i.jsx)(t.td,{children:"Script Runner shall support executing selected lines."}),(0,i.jsx)(t.td,{children:"Select a set of lines and execute them using Script->Execute Selected Lines."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-15"}),(0,i.jsx)(t.td,{children:"Script Runner shall support executing selected lines while paused."}),(0,i.jsx)(t.td,{children:"Select a set of lines and execute them from the right-click context menu."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-16"}),(0,i.jsx)(t.td,{children:"Script Runner shall support starting a script from any line."}),(0,i.jsx)(t.td,{children:"Place the mouse cursor at the desired first line and then select Script->Execute From Cursor."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-17"}),(0,i.jsx)(t.td,{children:"Script Runner shall support a mnemonic checking function."}),(0,i.jsx)(t.td,{children:"Select Script->Mnemonic Check."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-18"}),(0,i.jsx)(t.td,{children:"Script Runner shall support a syntax checking function."}),(0,i.jsx)(t.td,{children:"Select Script->Ruby Syntax Check."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-19"}),(0,i.jsx)(t.td,{children:"Script Runner shall support viewing the script instrumentation."}),(0,i.jsx)(t.td,{children:"Select Script->View Instrumented Script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-20"}),(0,i.jsx)(t.td,{children:"Script Runner shall support an disconnected mode to allow for executing scripts without a connection to the Command and Telemetry Server."}),(0,i.jsx)(t.td,{children:"Select Script->Toggle Disconnect. Execute a script with commands and check statements and verify that it runs to completion."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-21"}),(0,i.jsx)(t.td,{children:"Script Runner shall support a Debug terminal to aid in debugging scripts."}),(0,i.jsx)(t.td,{children:"Select Script->Toggle Debug."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-22"}),(0,i.jsx)(t.td,{children:"Script Runner shall support a step mode where the script will stop and wait for use interaction after each line."}),(0,i.jsx)(t.td,{children:"Press Step to progress through the script."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-23"}),(0,i.jsx)(t.td,{children:"Script Runner shall support breakpoint functionality."}),(0,i.jsx)(t.td,{children:"Create a breakpoint then execute the script and verify it stops at the specified line."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-25"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support executing individual test suites."}),(0,i.jsx)(t.td,{children:"Execute an individual test suite."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-26"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support executing individual test groups."}),(0,i.jsx)(t.td,{children:"Execute an individual test group."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-27"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support executing individual test cases."}),(0,i.jsx)(t.td,{children:"Execute an individual test case."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-28"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support executing test group setup and teardown methods individually."}),(0,i.jsx)(t.td,{children:"Execute a test group setup. Execute a test group teardown."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-29"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support executing test suite setup and teardown methods individually."}),(0,i.jsx)(t.td,{children:"Execute a test suite setup. Execute a test suite teardown."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-30"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall create a report after executing any suite test."}),(0,i.jsx)(t.td,{children:"Verify a report is generated after executing a suite."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-31"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support pausing when an error occurs."}),(0,i.jsx)(t.td,{children:"Execute a test script with the pause on error box checked and without."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-32"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support allowing the user to proceed on an error."}),(0,i.jsx)(t.td,{children:"Execute a test script with the Allow go/retry on error box checked and without."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-33"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support aborting execution on an error."}),(0,i.jsx)(t.td,{children:"Execute a test script with the abort on error box checked and without."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-34"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support looping a test."}),(0,i.jsx)(t.td,{children:"Execute a test script with the loop testing box checked and without."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-35"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support breaking the looping of a test on error."}),(0,i.jsx)(t.td,{children:"Execute a test script with the break loop on error box checked and without."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-36"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support a user readable flag indicating that loop testing is occurring."}),(0,i.jsx)(t.td,{children:"Execute a test script that checks the $loop_testing variable while looping and again while not looping."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"SR-37"}),(0,i.jsx)(t.td,{children:"Script Runner Suite Mode shall support a user readable flag indicating manual operations are desired."}),(0,i.jsx)(t.td,{children:"Execute a test script with the manual box checked and without."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"packet-viewer",children:"Packet Viewer"}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-1"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall allow selection of a telemetry packet by target name and packet name."}),(0,i.jsx)(t.td,{children:"Select a specific telemetry packet by target name and packet name in the drop down menus."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-2"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall display the contents of the selected telemetry packet."}),(0,i.jsx)(t.td,{children:"Ensure all items of the selected telemetry packet are displayed and updating."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-3"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall provide a mechanism to get detailed information on a telemetry item."}),(0,i.jsx)(t.td,{children:'Right click on a telemetry item and select "Details" from the context menu.'})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-4"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall provide a mechanism to view a graph of any telemetry item."}),(0,i.jsx)(t.td,{children:'Right click on a telemetry item and select "Graph" from the context menu.'})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-5"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall color telemetry values based upon limits state."}),(0,i.jsx)(t.td,{children:"View a packet with items containing limits and verify they are colored."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-6"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall support a configurable polling rate."}),(0,i.jsx)(t.td,{children:"Select File->Options and change the polling rate."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-7"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall support a color-blind mode to allow distinguishing limits states for those who are color blind."}),(0,i.jsx)(t.td,{children:"Select View->Color Blind Mode and verify that items with limits are also displayed with a textual indication of limits state color."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"PV-8"}),(0,i.jsx)(t.td,{children:"Packet Viewer shall support displaying telemetry in each of the four COSMOS value types (raw, converted, formatted, and formatted with units)"}),(0,i.jsx)(t.td,{children:"In the View menu, select each of the four value types and verify values are displayed accordingly."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"telemetry-viewer",children:"Telemetry Viewer"}),"\n",(0,i.jsx)(t.p,{children:'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.'}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TV-1"}),(0,i.jsx)(t.td,{children:"Telemetry Viewer shall display user-defined telemetry screens."}),(0,i.jsx)(t.td,{children:"Open a telemetry"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TV-2"}),(0,i.jsx)(t.td,{children:"Telemetry Viewer shall display realtime data."}),(0,i.jsx)(t.td,{children:"Verify telemetry screens show realtime data."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TV-3"}),(0,i.jsx)(t.td,{children:"Telemetry Viewer shall support saving open telemetry screens and their positions."}),(0,i.jsx)(t.td,{children:"Open three telemetry screens and then select File->Save Configuration."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"telemetry-grapher",children:"Telemetry Grapher"}),"\n",(0,i.jsx)(t.p,{children:"Telemetry Grapher performs graphing of telemetry points in both realtime and log file playback."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-1"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall provide line graphs of telemetry points."}),(0,i.jsx)(t.td,{children:"Add several housekeeping data objects to a plot."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-2"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support realtime graphing of telemetry."}),(0,i.jsx)(t.td,{children:"Press Start to start realtime graphing."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-3"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support graphing data from logged telemetry."}),(0,i.jsx)(t.td,{children:"Select the menu option to graph data from a logged data"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-4"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support multiple plots per browser tab."}),(0,i.jsx)(t.td,{children:"Add multiple plots."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-5"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support multiple telemetry points per plot."}),(0,i.jsx)(t.td,{children:"Add multiple data objects to one plot."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-6"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support saving a variable number of data points."}),(0,i.jsx)(t.td,{children:"Edit Points Saved."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-7"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support graphing a variable duration of time."}),(0,i.jsx)(t.td,{children:"Edit Seconds Plotted."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-8"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support graphing a variable number of data points."}),(0,i.jsx)(t.td,{children:"Edit Points Plotted."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-9"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support saving its configuration."}),(0,i.jsx)(t.td,{children:"Save the current configuration."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TG-10"}),(0,i.jsx)(t.td,{children:"Telemetry Grapher shall support loading its configuration."}),(0,i.jsx)(t.td,{children:"Load the previously saved configuration."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"data-extractor",children:"Data Extractor"}),"\n",(0,i.jsx)(t.p,{children:"Data Extractor processes logged data and extracts data into a CSV format for analysis in Excel or other tools."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-1"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support adding individual telemetry points."}),(0,i.jsx)(t.td,{children:"Add an individual telemetry point."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-2"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support adding entire telemetry packets."}),(0,i.jsx)(t.td,{children:"Add an entire packet."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-3"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support adding entire telemetry targets."}),(0,i.jsx)(t.td,{children:"Add all packets for a target."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-4"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support selecting the value type to extract for each telemetry point (RAW, CONVERTED, FORMATTED, WITH_UNITS)"}),(0,i.jsx)(t.td,{children:"Click an item and change the value type."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-5"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support saving configurations."}),(0,i.jsx)(t.td,{children:"Select File->Save Config"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-6"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support loading configurations."}),(0,i.jsx)(t.td,{children:"Select File->Load Config"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DE-7"}),(0,i.jsx)(t.td,{children:"Data Extractor shall support deleting items"}),(0,i.jsx)(t.td,{children:"Select an Item and press delete"})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"data-viewer",children:"Data Viewer"}),"\n",(0,i.jsx)(t.p,{children:"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."}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DV-1"}),(0,i.jsx)(t.td,{children:"Data Viewer shall support realtime processing of telemetry packets."}),(0,i.jsx)(t.td,{children:"Press Start to start realtime processing."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DV-2"}),(0,i.jsx)(t.td,{children:"Data Viewer shall support logged playback of telemetry packets."}),(0,i.jsx)(t.td,{children:"Select a time range to playback."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DV-3"}),(0,i.jsx)(t.td,{children:"Data Viewer shall support textual display of telemetry packets."}),(0,i.jsx)(t.td,{children:"View the display of data."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DV-4"}),(0,i.jsx)(t.td,{children:"Data Viewer shall support multiple tabs for data display."}),(0,i.jsx)(t.td,{children:"Switch between several tabs of data."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"DV-5"}),(0,i.jsx)(t.td,{children:"Data Viewer shall support deleting tabs."}),(0,i.jsx)(t.td,{children:"Delete a tab."})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"calendar",children:"Calendar"}),"\n",(0,i.jsx)(t.p,{children:"The Calendar tool provides a user interface and API for initiating scheduled actions in COSMOS"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-1"}),(0,i.jsx)(t.td,{children:"Calendar shall allow creating new timelines"}),(0,i.jsx)(t.td,{children:"Click the button and create a new timeline"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-2"}),(0,i.jsx)(t.td,{children:"Calendar shall allow scheduling commands for future execection"}),(0,i.jsx)(t.td,{children:"Add a command to a timeline"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-3"}),(0,i.jsx)(t.td,{children:"Calendar shall allow scheduling scripts for future execution"}),(0,i.jsx)(t.td,{children:"Add a script to a timeline"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-4"}),(0,i.jsx)(t.td,{children:"Calendar shall allow for reserving a resource"}),(0,i.jsx)(t.td,{children:"Add a reservation to a timeline"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-5"}),(0,i.jsx)(t.td,{children:"Calendar shall track success or failure of commands"}),(0,i.jsx)(t.td,{children:"Look at status from a completed command"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-6"}),(0,i.jsx)(t.td,{children:"Calendar shall track success or failure of scripts"}),(0,i.jsx)(t.td,{children:"Look at status from a completed script"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-7"}),(0,i.jsx)(t.td,{children:"Calendar shall allow deleting activities from timelines"}),(0,i.jsx)(t.td,{children:"Delete a preexisting item from a timeline"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"TL-8"}),(0,i.jsx)(t.td,{children:"Calendar shall allow deleting timelines"}),(0,i.jsx)(t.td,{children:"Delete a timeline"})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"admin",children:"Admin"}),"\n",(0,i.jsx)(t.p,{children:"The Admin tool provides administrative functionality including managing plugins for the COSMOS system"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Reqt. ID"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Test Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-1"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall allow installing plugins"}),(0,i.jsx)(t.td,{children:"Upload and Install a Plugin"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-2"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support upgrading plugins"}),(0,i.jsx)(t.td,{children:"Upgrade an installed plugin"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-3"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support uninstalling plugins"}),(0,i.jsx)(t.td,{children:"Uninstall a plugin"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-4"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall display information on installed plugins"}),(0,i.jsx)(t.td,{children:"View info on Interfaces, Microservices, etc"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-5"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support editing microservices"}),(0,i.jsx)(t.td,{children:"Edit the settings for a microservice"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-6"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support discovery of plugins"}),(0,i.jsx)(t.td,{children:"Discover and download a plugin"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-7"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support adding links to external tools"}),(0,i.jsx)(t.td,{children:"Add a link to Google"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-8"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support reordering tools"}),(0,i.jsx)(t.td,{children:"Reorder tools on the tools tab"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"AD-9"}),(0,i.jsx)(t.td,{children:"The Admin Tool shall support configuring a classification bar"}),(0,i.jsx)(t.td,{children:"Add a classification bar on the settings tab"})]})]})]})]})}function o(e={}){let{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},854:function(e,t,r){r.d(t,{Z:()=>s});let s=r.p+"assets/images/architecture-b78f12eba076a0c07af7abdd9dd4187c59aa6b4f5c51b47ad03f73e9f98a6ed6.png"}}]);

data/tools/staticdocs/assets/js/6b65133b.b2a62736.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["1417"],{2747:function(e,n,t){t.d(n,{Z:()=>i});let i=t.p+"assets/images/edit_screen-c655c75fe90429c0425b61cccf23835b6882975abaa56de21d58c9a4b19a4773.png"},2840:function(e,n,t){t.d(n,{Z:()=>c,a:()=>r});var i=t(2784);let s={},o=i.createContext(s);function r(e){let n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}},370:function(e,n,t){t.d(n,{Z:()=>i});let i=t.p+"assets/images/file_menu-8a0c6243e35822617229a729a598ace78e401b6c29f66eb5e07035d77d9be1aa.png"},4245:function(e,n,t){t.d(n,{Z:()=>i});let i=t.p+"assets/images/float_minimize-a27fc649e517b279db5d2435fbd4f1de81418b9ef5f47fc83a9443bba0b1a7e0.png"},5525:function(e,n,t){t.r(n),t.d(n,{frontMatter:()=>r,default:()=>h,contentTitle:()=>c,assets:()=>l,toc:()=>a,metadata:()=>i});var i=JSON.parse('{"id":"tools/tlm-viewer","title":"Telemetry Viewer","description":"Build custom screens using built-in widgets","source":"@site/docs/tools/tlm-viewer.md","sourceDirName":"tools","slug":"/tools/tlm-viewer","permalink":"/tools/staticdocs/docs/tools/tlm-viewer","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/tlm-viewer.md","tags":[],"version":"current","frontMatter":{"title":"Telemetry Viewer","description":"Build custom screens using built-in widgets","sidebar_custom_props":{"myEmoji":"\uD83D\uDEE0\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Telemetry Grapher","permalink":"/tools/staticdocs/docs/tools/tlm-grapher"},"next":{"title":"Guides","permalink":"/tools/staticdocs/docs/guides"}}'),s=t(2322),o=t(2840);let r={title:"Telemetry Viewer",description:"Build custom screens using built-in widgets",sidebar_custom_props:{myEmoji:"\uD83D\uDEE0\uFE0F"}},c=void 0,l={},a=[{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}];function d(e){let n={a:"a",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsx)(n.p,{children:"Telemetry Viewer is a live telemetry viewer which displays custom built screens. Screens are configured through simple text files which utilize numerous built-in widgets."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Telemetry Viewer",src:t(6574).Z+"",width:"1274",height:"895"})}),"\n",(0,s.jsx)(n.h3,{id:"file-menu-items",children:"File Menu Items"}),"\n",(0,s.jsx)("img",{src:t(370).Z,alt:"File Menu",style:{float:"left","margin-right":"50px",height:"90px"}}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Open a saved configuration"}),"\n",(0,s.jsx)(n.li,{children:"Save the current configuration"}),"\n",(0,s.jsx)(n.li,{children:"Reset the configuration (default settings)"}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"open-configuration",children:"Open Configuration"}),"\n",(0,s.jsx)(n.p,{children:"The Open Configuration dialog displays a list of all saved configurations. 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."}),"\n",(0,s.jsx)(n.h4,{id:"save-configuration",children:"Save Configuration"}),"\n",(0,s.jsx)(n.p,{children:"The Save Configuration dialog also displays a list of all saved configurations. 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."}),"\n",(0,s.jsx)(n.h2,{id:"selecting-screens",children:"Selecting Screens"}),"\n",(0,s.jsx)(n.p,{children:"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."}),"\n",(0,s.jsx)(n.h2,{id:"new-screen",children:"New Screen"}),"\n",(0,s.jsx)(n.p,{children:"Clicking New Screen brings up the new screen dialog."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Telemetry Viewer",src:t(6374).Z+"",width:"595",height:"424"})}),"\n",(0,s.jsx)(n.p,{children:"Screens are owned by Targets so Select Target chooses where the screen will be created. 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. Note that screen names must be unique so the screen name is set to 'adcs2' since an 'ADCS' screen already exists."}),"\n",(0,s.jsx)(n.h2,{id:"edit-screen",children:"Edit Screen"}),"\n",(0,s.jsx)(n.p,{children:"Clicking the pencil icon in the title bar of the screen brings up the edit dialog."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Telemetry Viewer",src:t(2747).Z+"",width:"1149",height:"698"})}),"\n",(0,s.jsx)(n.p,{children:"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."}),"\n",(0,s.jsx)(n.h2,{id:"screen-window-management",children:"Screen Window Management"}),"\n",(0,s.jsx)(n.p,{children:"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."}),"\n",(0,s.jsx)(n.p,{children:"You can also float the screens by clicking the grid icon in the upper left of the title bar. It will change to a balloon icon and allow you to click up and down to change the relative Z index of the window. The image screen is floated in the following screen shot."}),"\n",(0,s.jsx)(n.p,{children:"The dash button in the upper right of the title bar minimizes the screen to effectively hide it. This allows you to focus on a single screen without closing existing screens. In the screen shot below there are two minimized windows at the very bottom."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Float Minimized",src:t(4245).Z+"",width:"1275",height:"928"})}),"\n",(0,s.jsx)(n.p,{children:"The X button closes the screen."}),"\n",(0,s.jsx)(n.h2,{id:"building-screens",children:"Building Screens"}),"\n",(0,s.jsxs)(n.p,{children:["For documentation on how to build Telemetry Screens and how to configure the\nscreen widgets please see the ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens",children:"Telemetry Screens"}),"."]})]})}function h(e={}){let{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},6374:function(e,n,t){t.d(n,{Z:()=>i});let i=t.p+"assets/images/new_screen-0d9bea0538e91fa2332346f1ff73b1dda2e418d295dcd7d6a13ba240cf32187e.png"},6574:function(e,n,t){t.d(n,{Z:()=>i});let i=t.p+"assets/images/telemetry_viewer-e4ac466930993a640f95aea4b01bb9a415eec77dfbfaa184f767cb59940ba943.png"}}]);

data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["5390"],{2840:function(e,t,s){s.d(t,{Z:()=>a,a:()=>i});var n=s(2784);let o={},r=n.createContext(o);function i(e){let t=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(r.Provider,{value:t},e.children)}},5089:function(e,t,s){s.r(t),s.d(t,{frontMatter:()=>i,default:()=>p,contentTitle:()=>a,assets:()=>l,toc:()=>c,metadata:()=>n});var n=JSON.parse('{"id":"development/roadmap","title":"Roadmap","description":"COSMOS roadmap now and into the future","source":"@site/docs/development/roadmap.md","sourceDirName":"development","slug":"/development/roadmap","permalink":"/tools/staticdocs/docs/development/roadmap","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/roadmap.md","tags":[],"version":"current","frontMatter":{"title":"Roadmap","description":"COSMOS roadmap now and into the future","sidebar_custom_props":{"myEmoji":"\uD83D\uDDFA\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Log Structure","permalink":"/tools/staticdocs/docs/development/log-structure"},"next":{"title":"Streaming API","permalink":"/tools/staticdocs/docs/development/streaming-api"}}'),o=s(2322),r=s(2840);let i={title:"Roadmap",description:"COSMOS roadmap now and into the future",sidebar_custom_props:{myEmoji:"\uD83D\uDDFA\uFE0F"}},a=void 0,l={},c=[{value:"OpenC3 COSMOS 6.x",id:"openc3-cosmos-6x",level:2},{value:"OpenC3 COSMOS 7.x",id:"openc3-cosmos-7x",level:2},{value:"Github Issues",id:"github-issues",level:2}];function d(e){let t={a:"a",h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Please read the release notes on the ",(0,o.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/releases",children:"Releases"})," page to learn about current functionality."]}),"\n",(0,o.jsx)(t.h2,{id:"openc3-cosmos-6x",children:"OpenC3 COSMOS 6.x"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["Plugin App Store",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["System Health Tool (Enterprise)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["COSMOS Notebooks (similar to Jupyter Notebooks)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Log Message Extractor Tool (Enterprise)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Telemetry Viewer screen playback of historical data",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["libCSP Interface (Cubesat Space Protocol)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Standardized Interfaces for common message buses (ZeroMQ, ActiveMQ, etc)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Integration with ground networks (Atlas, RBC Signals)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Integration with mission planning (Orbit Logic, Cognitive Space)",(0,o.jsx)("br",{})]}),"\n",(0,o.jsxs)(t.li,{children:["Integration with flight dynamics (Kayhan, SEE, Exotrail)",(0,o.jsx)("br",{})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"openc3-cosmos-7x",children:"OpenC3 COSMOS 7.x"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"Super Bridge - This will enable SaaS COSMOS and provide a secure method to communicate from a cloud server to an intranet for hardware control"}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"github-issues",children:"Github Issues"}),"\n",(0,o.jsxs)(t.p,{children:["We prioritize bugs and customer requests in our Github ",(0,o.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/issues",children:"issues"})," list. If you're an OpenC3 customer, please reach out at ",(0,o.jsx)(t.a,{href:"mailto:support@openc3.com",children:"support@openc3.com"})," and let us know what issues you need prioritized."]})]})}function p(e={}){let{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}}}]);

data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["9278"],{2840:function(e,t,s){s.d(t,{Z:()=>a,a:()=>d});var n=s(2784);let r={},i=n.createContext(r);function d(e){let t=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),n.createElement(i.Provider,{value:t},e.children)}},2917:function(e,t,s){s.d(t,{Z:()=>n});let n=s.p+"assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png"},4564:function(e,t,s){s.r(t),s.d(t,{frontMatter:()=>d,default:()=>o,contentTitle:()=>a,assets:()=>l,toc:()=>c,metadata:()=>n});var n=JSON.parse('{"id":"configuration/command","title":"Commands","description":"Command definition file format and keywords","source":"@site/docs/configuration/command.md","sourceDirName":"configuration","slug":"/configuration/command","permalink":"/tools/staticdocs/docs/configuration/command","draft":false,"unlisted":false,"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","description":"Command definition file format and keywords","sidebar_custom_props":{"myEmoji":"\uD83D\uDCE1"}},"sidebar":"defaultSidebar","previous":{"title":"Targets","permalink":"/tools/staticdocs/docs/configuration/target"},"next":{"title":"Telemetry","permalink":"/tools/staticdocs/docs/configuration/telemetry"}}'),r=s(2322),i=s(2840);let d={sidebar_position:4,title:"Commands",description:"Command definition file format and keywords",sidebar_custom_props:{myEmoji:"\uD83D\uDCE1"}},a=void 0,l={},c=[{value:"Command Concepts",id:"command-concepts",level:2},{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:"VARIABLE_BIT_SIZE",id:"variable_bit_size",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:"RESPONSE",id:"response",level:3},{value:"ERROR_RESPONSE",id:"error_response",level:3},{value:"RELATED_ITEM",id:"related_item",level:3},{value:"SCREEN",id:"screen",level:3},{value:"VIRTUAL",id:"virtual",level:3},{value:"RESTRICTED",id:"restricted",level:3},{value:"VALIDATOR",id:"validator",level:3},{value:"SELECT_COMMAND",id:"select_command",level:2},{value:"Example File",id:"example-file",level:2}];function h(e){let t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"command-concepts",children:"Command Concepts"}),"\n",(0,r.jsxs)(t.p,{children:["The COSMOS front end provides multiple ways to send commands. They can come from a script (e.g. in ",(0,r.jsx)(t.a,{href:"../tools/script-runner",children:"Script Runner"}),"), a tool like ",(0,r.jsx)(t.a,{href:"../tools/cmd-sender",children:"Command Sender"}),", or just generally through an API call. These requests will go to the CmdTlmApi Server to start the flow through the rest of the COSMOS architecture and out to the target as follows:"]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Command Processing Diagram",src:s(2917).Z+"",width:"781",height:"771"})}),"\n",(0,r.jsx)(t.h2,{id:"command-definition-files",children:"Command Definition Files"}),"\n",(0,r.jsxs)(t.p,{children:["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 easiest 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.jsx)(t.a,{href:"http://www.asciitable.com/",children:"ASCII Table"})," is structured, files beginning with capital letters are processed before lower case letters."]}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsx)("div",{style:{clear:"both"}}),"\n",(0,r.jsx)(t.h1,{id:"command-keywords",children:"Command Keywords"}),"\n",(0,r.jsx)(t.h2,{id:"command",children:"COMMAND"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a new command packet"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target"}),(0,r.jsx)(t.td,{children:"Name of the target this command is associated with"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Command"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description of this command which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'COMMAND INST COLLECT BIG_ENDIAN "Start collect"\n'})}),"\n",(0,r.jsx)(t.h2,{id:"command-modifiers",children:"COMMAND Modifiers"}),"\n",(0,r.jsx)(t.p,{children:"The following keywords must follow a COMMAND keyword."}),"\n",(0,r.jsx)(t.h3,{id:"parameter",children:"PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a command parameter in the current command packet"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Offset"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of this parameter",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Minimum Value"}),(0,r.jsx)(t.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Maximum Value"}),(0,r.jsx)(t.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.jsx)(t.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'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'})}),"\n",(0,r.jsx)(t.h3,{id:"parameter-modifiers",children:"PARAMETER Modifiers"}),"\n",(0,r.jsx)(t.p,{children:"The following keywords must follow a PARAMETER keyword."}),"\n",(0,r.jsx)(t.h4,{id:"format_string",children:"FORMAT_STRING"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Adds printf style formatting"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Format"}),(0,r.jsx)(t.td,{children:"How to format using printf syntax. For example, '0x%0X' will display the value in hex."}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'FORMAT_STRING "0x%0X"\n'})}),"\n",(0,r.jsx)(t.h4,{id:"units",children:"UNITS"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Add displayed units"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Full Name"}),(0,r.jsx)(t.td,{children:"Full name of the units type, e.g. Celsius"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Abbreviated"}),(0,r.jsx)(t.td,{children:"Abbreviation for the units, e.g. C"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"UNITS Celsius C\nUNITS Kilometers KM\n"})}),"\n",(0,r.jsx)(t.h4,{id:"description",children:"DESCRIPTION"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Override the defined description"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Value"}),(0,r.jsx)(t.td,{children:"The new description"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"meta",children:"META"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Stores custom user metadata"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Meta Name"}),(0,r.jsx)(t.td,{children:"Name of the metadata to store"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Meta Values"}),(0,r.jsx)(t.td,{children:"One or more values to be stored for this Meta Name"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'META TEST "This parameter is for test purposes only"\n'})}),"\n",(0,r.jsx)(t.h4,{id:"overlap",children:"OVERLAP"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 4.4.1)"}),(0,r.jsx)(t.strong,{children:"This item is allowed to overlap other items in the packet"})]}),"\n",(0,r.jsx)(t.p,{children:"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and suppresses the warning message."}),"\n",(0,r.jsx)(t.h4,{id:"key",children:"KEY"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,r.jsx)(t.strong,{children:"Defines the key used to access this raw value in the packet."})]}),"\n",(0,r.jsxs)(t.p,{children:["Keys are often ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/JSONPath",children:"JSONPath"})," or ",(0,r.jsx)(t.a,{href:"https://en.wikipedia.org/wiki/XPath",children:"XPath"})," strings"]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Key string"}),(0,r.jsx)(t.td,{children:"The key to access this item"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"KEY $.book.title\n"})}),"\n",(0,r.jsx)(t.h4,{id:"variable_bit_size",children:"VARIABLE_BIT_SIZE"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.18.0)"}),(0,r.jsx)(t.strong,{children:"Marks an item as having its bit size defined by another length item"})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Item Name"}),(0,r.jsx)(t.td,{children:"The name of the associated length item"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Bits Per Count"}),(0,r.jsx)(t.td,{children:"Bits per count of the length item. Defaults to 8"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Value Bit Offset"}),(0,r.jsx)(t.td,{children:"Offset in Bits to Apply to Length Field Value. Defaults to 0"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"required",children:"REQUIRED"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Parameter is required to be populated in scripts"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsx)(t.h4,{id:"minimum_value",children:"MINIMUM_VALUE"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Override the defined minimum value"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Value"}),(0,r.jsx)(t.td,{children:"The new minimum value for the parameter"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"maximum_value",children:"MAXIMUM_VALUE"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Override the defined maximum value"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Value"}),(0,r.jsx)(t.td,{children:"The new maximum value for the parameter"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"default_value",children:"DEFAULT_VALUE"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Override the defined default value"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Value"}),(0,r.jsx)(t.td,{children:"The new default value for the parameter"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"state",children:"STATE"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a key/value pair for the current command parameter"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Key"}),(0,r.jsx)(t.td,{children:"The string state name"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Value"}),(0,r.jsx)(t.td,{children:"The numerical state value"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Hazardous / Disable Messages"}),(0,r.jsxs)(t.td,{children:["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.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"HAZARDOUS"})]}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Hazardous Description"}),(0,r.jsx)(t.td,{children:"String describing why this state is hazardous"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'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'})}),"\n",(0,r.jsx)(t.h4,{id:"write_conversion",children:"WRITE_CONVERSION"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Applies a conversion when writing the current command parameter"})}),"\n",(0,r.jsxs)(t.p,{children:["Conversions are implemented in a custom Ruby or Python file which should be\nlocated in the target's lib folder. The class must inherit from Conversion.\nIt must implement the ",(0,r.jsx)(t.code,{children:"initialize"})," (Ruby) or ",(0,r.jsx)(t.code,{children:"__init__"})," (Python) method if it\ntakes extra parameters and must always implement the ",(0,r.jsx)(t.code,{children:"call"})," method. The conversion\nfactor is applied to the value entered by the user before it is written into\nthe binary command packet and sent. For more information see the ",(0,r.jsx)(t.a,{href:"/docs/configuration/conversions",children:"Conversion"})," documentation."]}),"\n",(0,r.jsxs)(t.p,{children:["When applying a write_conversion sometimes the data type changes,\ne.g. creating a UINT from an input STRING (for an example of this see\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/conversions/ip_write_conversion.rb",children:"ip_write_conversion.rb"}),"\nor ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/conversions/ip_write_conversion.py",children:"ip_write_conversion.py"}),").\nIn this case, the command definition data type is UINT and the min, max values don't matter\n(but must be given) so are typically set to MIN MAX. The default value is important\nand should be specified as a string. For a full example see the IP_ADDRESS parameter\nin the TIME_OFFSET command definition of the COSMOS Demo\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt",children:"INST inst_cmds.txt"}),"\nor ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt",children:"INST2 inst_cmds.txt"}),"."]}),"\n",(0,r.jsx)(t.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,r.jsx)(t.p,{children:"When a command is built, each item gets written (and write conversions are run)\nto set the default value. Then items are written (again write conversions are run)\nwith user provided values. Thus write conversions can be run twice. Also there are\nno guarantees which parameters have already been written. The packet itself has a\ngiven_values() method which can be used to retrieve a hash of the user provided\nvalues to the command. That can be used to check parameter values passed in."})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Class Filename"}),(0,r.jsx)(t.td,{children:"The filename which contains the Ruby or Python 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'. Note the built-in Python conversions must specify the full path to the file, e.g. 'openc3/conversions/bit_reverse_conversion.py'."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Parameter"}),(0,r.jsx)(t.td,{children:"Additional parameter values for the conversion which are passed to the class constructor."}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Ruby Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"WRITE_CONVERSION ip_write_conversion.rb\n"})}),"\n",(0,r.jsx)(t.p,{children:"Python Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:"WRITE_CONVERSION openc3/conversions/ip_write_conversion.py\n"})}),"\n",(0,r.jsx)(t.h4,{id:"poly_write_conversion",children:"POLY_WRITE_CONVERSION"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Adds a polynomial conversion factor to the current command parameter"})}),"\n",(0,r.jsxs)(t.p,{children:["See ",(0,r.jsx)(t.a,{href:"/docs/configuration/conversions#polynomial_conversion",children:"Polynomial Conversion"})," for more information."]}),"\n",(0,r.jsx)(t.h4,{id:"seg_poly_write_conversion",children:"SEG_POLY_WRITE_CONVERSION"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Adds a segmented polynomial conversion factor to the current command parameter"})}),"\n",(0,r.jsxs)(t.p,{children:["See ",(0,r.jsx)(t.a,{href:"/docs/configuration/conversions#segmented_polynomial_conversion",children:"Segmented Polynomial Conversion"})," for more information."]}),"\n",(0,r.jsx)(t.h4,{id:"generic_write_conversion_start",children:"GENERIC_WRITE_CONVERSION_START"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Start a generic write conversion"})}),"\n",(0,r.jsx)(t.p,{children:"Adds a generic conversion function to the current command parameter.\nThis conversion factor is applied to the value entered by the user before it\nis written into the binary command packet and sent. The conversion is specified\nas Ruby or Python code that receives two implied parameters. 'value' which is the raw\nvalue being written and 'packet' which is a reference to the command packet\nclass (Note, referencing the packet as 'myself' is still supported for backwards\ncompatibility). The last line of code should return the converted\nvalue. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of\ncode for the conversion have been given."}),"\n",(0,r.jsx)(t.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,r.jsx)(t.p,{children:"When a command is built, each item gets written (and write conversions are run)\nto set the default value. Then items are written (again write conversions are run)\nwith user provided values. Thus write conversions can be run twice. Also there are\nno guarantees which parameters have already been written. The packet itself has a\ngiven_values() method which can be used to retrieve a hash of the user provided\nvalues to the command. That can be used to check parameter values passed in."})}),"\n",(0,r.jsx)(t.admonition,{type:"warning",children:(0,r.jsx)(t.p,{children:"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."})}),"\n",(0,r.jsx)(t.p,{children:"Ruby Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    return (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n"})}),"\n",(0,r.jsx)(t.p,{children:"Python Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    return int(value * 1.5) # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n"})}),"\n",(0,r.jsx)(t.h4,{id:"generic_write_conversion_end",children:"GENERIC_WRITE_CONVERSION_END"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Complete a generic write conversion"})}),"\n",(0,r.jsx)(t.h4,{id:"overflow",children:"OVERFLOW"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Set the behavior when writing a value overflows the type"})}),"\n",(0,r.jsx)(t.p,{children:"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 written, e.g. you can successfully write 255 to a 8 bit signed value."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Behavior"}),(0,r.jsxs)(t.td,{children:["How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE"})]}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"OVERFLOW TRUNCATE\n"})}),"\n",(0,r.jsx)(t.h3,{id:"append_parameter",children:"APPEND_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a command parameter in the current command packet"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of this parameter",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Minimum Value"}),(0,r.jsx)(t.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Maximum Value"}),(0,r.jsx)(t.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.jsx)(t.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'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'})}),"\n",(0,r.jsx)(t.h3,{id:"id_parameter",children:"ID_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines an identification command parameter in the current command packet"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Offset"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of this parameter",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Minimum Value"}),(0,r.jsx)(t.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Maximum Value"}),(0,r.jsx)(t.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"ID Value"}),(0,r.jsx)(t.td,{children:"Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.jsx)(t.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"\n'})}),"\n",(0,r.jsx)(t.h3,{id:"append_id_parameter",children:"APPEND_ID_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines an identification command parameter in the current command packet"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of this parameter",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Minimum Value"}),(0,r.jsx)(t.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Maximum Value"}),(0,r.jsx)(t.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"ID Value"}),(0,r.jsx)(t.td,{children:"Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.jsx)(t.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Default Value"}),(0,r.jsx)(t.td,{children:"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."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"\n'})}),"\n",(0,r.jsx)(t.h3,{id:"array_parameter",children:"ARRAY_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a command parameter in the current command packet that is an array"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Offset"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Item Bit Size"}),(0,r.jsx)(t.td,{children:"Bit size of each array item"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Item Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of each array item",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, STRING, BLOCK, DERIVED"})]}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Array Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"\n'})}),"\n",(0,r.jsx)(t.h3,{id:"append_array_parameter",children:"APPEND_ARRAY_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Defines a command parameter in the current command packet that is an array"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Name"}),(0,r.jsx)(t.td,{children:"Name of the parameter. Must be unique within the command."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Item Bit Size"}),(0,r.jsx)(t.td,{children:"Bit size of each array item"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Item Data Type"}),(0,r.jsxs)(t.td,{children:["Data Type of each array item",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, STRING, BLOCK, DERIVED"})]}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Array Bit Size"}),(0,r.jsx)(t.td,{children:"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.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsxs)(t.td,{children:["Indicates if the data is to be sent in Big Endian or Little Endian format",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"\n'})}),"\n",(0,r.jsx)(t.h3,{id:"select_parameter",children:"SELECT_PARAMETER"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Selects an existing command parameter for editing"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Parameter"}),(0,r.jsx)(t.td,{children:"Name of the parameter to select for modification"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n"})}),"\n",(0,r.jsx)(t.h3,{id:"delete_parameter",children:"DELETE_PARAMETER"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 4.4.1)"}),(0,r.jsx)(t.strong,{children:"Deletes an existing command parameter from the packet definition"})]}),"\n",(0,r.jsx)(t.p,{children:'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.'}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Parameter"}),(0,r.jsx)(t.td,{children:"Name of the parameter to delete"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  DELETE_PARAMETER DURATION\n"})}),"\n",(0,r.jsx)(t.h3,{id:"hidden",children:"HIDDEN"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsx)(t.h3,{id:"disabled",children:"DISABLED"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Disables this command from being sent"})}),"\n",(0,r.jsx)(t.p,{children:"Hides the command and also disables it from being sent by scripts. Attempts to send DISABLED commands result in an error message."}),"\n",(0,r.jsx)(t.h3,{id:"disable_messages",children:"DISABLE_MESSAGES"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Disable the Server from printing cmd(...) messages. Commands are still logged."})}),"\n",(0,r.jsx)(t.h3,{id:"meta-1",children:"META"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Stores metadata for the current command"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Meta Name"}),(0,r.jsx)(t.td,{children:"Name of the metadata to store"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Meta Values"}),(0,r.jsx)(t.td,{children:"One or more values to be stored for this Meta Name"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'META FSW_TYPE "struct command"\n'})}),"\n",(0,r.jsx)(t.h3,{id:"hazardous",children:"HAZARDOUS"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Designates the current command as hazardous"})}),"\n",(0,r.jsx)(t.p,{children:"Sending a hazardous command causes a dialog asking for confirmation before sending the command"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Description"}),(0,r.jsx)(t.td,{children:"Description for why the command is hazardous which must be enclosed with quotes"}),(0,r.jsx)(t.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(t.h3,{id:"accessor",children:"ACCESSOR"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,r.jsx)(t.strong,{children:"Defines the class used to read and write raw values from the packet"})]}),"\n",(0,r.jsxs)(t.p,{children:["Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. For more information see ",(0,r.jsx)(t.a,{href:"accessors",children:"Accessors"}),"."]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Accessor Class Name"}),(0,r.jsx)(t.td,{children:"The name of the accessor class"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Argument"}),(0,r.jsx)(t.td,{children:"Additional argument passed to the accessor class constructor"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"template",children:"TEMPLATE"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,r.jsx)(t.strong,{children:"Defines a template string used to initialize the command before default values are filled in"})]}),"\n",(0,r.jsx)(t.p,{children:"Generally the template string is formatted in JSON or HTML and then values are filled in with command parameters. Must be UTF-8 encoded."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Template"}),(0,r.jsx)(t.td,{children:"The template string which should be enclosed in quotes"}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h3,{id:"template_file",children:"TEMPLATE_FILE"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,r.jsx)(t.strong,{children:"Defines a template file used to initialize the command before default values are filled in"})]}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Template File Path"}),(0,r.jsx)(t.td,{children:"The relative path to the template file. Filename should generally start with an underscore."}),(0,r.jsx)(t.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(t.h3,{id:"response",children:"RESPONSE"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,r.jsx)(t.strong,{children:"Indicates the expected telemetry packet response to this command"})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Target Name of telemetry response packet"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Packet Name"}),(0,r.jsx)(t.td,{children:"Packet Name of telemetry response packet"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"error_response",children:"ERROR_RESPONSE"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,r.jsx)(t.strong,{children:"Indicates the expected telemetry packet error response to this command"})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Target Name of telemetry error response packet"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Packet Name"}),(0,r.jsx)(t.td,{children:"Packet Name of telemetry error response packet"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"related_item",children:"RELATED_ITEM"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,r.jsx)(t.strong,{children:"Defines a related telemetry item to this command"})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Target Name of related telemetry item"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Packet Name"}),(0,r.jsx)(t.td,{children:"Packet Name of related telemetry item"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Item Name"}),(0,r.jsx)(t.td,{children:"Item Name of related telemetry item"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"screen",children:"SCREEN"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,r.jsx)(t.strong,{children:"Defines a related telemetry screen to this command"})]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Target Name of related telemetry screen"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Screen Name"}),(0,r.jsx)(t.td,{children:"Screen Name of related telemetry screen"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"virtual",children:"VIRTUAL"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.18.0)"}),(0,r.jsx)(t.strong,{children:"Marks this packet as virtual and not participating in identification"})]}),"\n",(0,r.jsx)(t.p,{children:"Used for packet definitions that can be used as structures for items with a given packet."}),"\n",(0,r.jsx)(t.h3,{id:"restricted",children:"RESTRICTED"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.20.0)"}),(0,r.jsx)(t.strong,{children:"Marks this packet as restricted and will require approval if critical commanding is enabled"})]}),"\n",(0,r.jsx)(t.p,{children:"Used as one of the two types of critical commands (HAZARDOUS and RESTRICTED)"}),"\n",(0,r.jsx)(t.h3,{id:"validator",children:"VALIDATOR"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.19.0)"}),(0,r.jsx)(t.strong,{children:"Defines a validator class for a command"})]}),"\n",(0,r.jsx)(t.p,{children:"Validator class is used to validate the command success or failure with both a pre_check and post_check method."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Class Filename"}),(0,r.jsx)(t.td,{children:"The filename which contains the Ruby or Python class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'command_validator.rb' should contain 'class CommandValidator'."}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Argument"}),(0,r.jsx)(t.td,{children:"Additional argument passed to the validator class constructor"}),(0,r.jsx)(t.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Ruby Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'VALIDATOR custom_validator.rb\n\nDefined in custom_validator.rb:\n\nrequire \'openc3/packets/command_validator\'\nclass CustomValidator < OpenC3::CommandValidator\n  # Both the pre_check and post_check are passed the command packet that was sent\n  # You can inspect the command in your checks as follows:\n  #   packet.target_name => target name\n  #   packet.packet_name => packet name (command name)\n  #   packet.read("ITEM") => converted value\n  #   packet.read("ITEM", :RAW) => raw value\n  def pre_check(packet)\n    if tlm("TGT PKT ITEM") == 0\n      return [false, "TGT PKT ITEM is 0"]\n    end\n    @cmd_acpt_cnt = tlm("TGT PKT CMD_ACPT_CNT")\n    return [true, nil]\n  end\n  def post_check(packet)\n    wait_check("TGT PKT CMD_ACPT_CNT > #{@cmd_acpt_cnt}", 10)\n    return [true, nil]\n  end\nend\n'})}),"\n",(0,r.jsx)(t.p,{children:"Python Example:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-python",children:'VALIDATOR custom_validator.rb\n\nDefined in custom_validator.py:\n\nclass CustomValidator(CommandValidator):\n    # Both the pre_check and post_check are passed the command packet that was sent\n    # You can inspect the command in your checks as follows:\n    #   packet.target_name => target name\n    #   packet.packet_name => packet name (command name)\n    #   packet.read("ITEM") => converted value\n    #   packet.read("ITEM", :RAW) => raw value\n    def pre_check(self, command):\n        if tlm("TGT PKT ITEM") == 0:\n            return [False, "TGT PKT ITEM is 0"]\n        self.cmd_acpt_cnt = tlm("INST HEALTH_STATUS CMD_ACPT_CNT")\n        return [True, None]\n\n    def post_check(self, command):\n        wait_check(f"INST HEALTH_STATUS CMD_ACPT_CNT > {self.cmd_acpt_cnt}", 10)\n        return [True, None]\n'})}),"\n",(0,r.jsx)(t.h2,{id:"select_command",children:"SELECT_COMMAND"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Selects an existing command packet for editing"})}),"\n",(0,r.jsx)(t.p,{children:"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."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Name of the target this command is associated with"}),(0,r.jsx)(t.td,{children:"True"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Command Name"}),(0,r.jsx)(t.td,{children:"Name of the command to select"}),(0,r.jsx)(t.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-file",children:"Example File"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Example File: TARGET/cmd_tlm/cmd.txt"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:'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'})})]})}function o(e={}){let{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]);

data/tools/staticdocs/assets/js/75e64983.e0eb7741.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["2448"],{2840:function(e,n,o){o.d(n,{Z:()=>l,a:()=>r});var t=o(2784);let i={},s=t.createContext(i);function r(e){let n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}},3896:function(e,n,o){o.r(n),o.d(n,{frontMatter:()=>r,default:()=>h,contentTitle:()=>l,assets:()=>a,toc:()=>c,metadata:()=>t});var t=JSON.parse('{"id":"getting-started/upgrading","title":"Upgrading","description":"How to upgrade and migrate COSMOS","source":"@site/docs/getting-started/upgrading.md","sourceDirName":"getting-started","slug":"/getting-started/upgrading","permalink":"/tools/staticdocs/docs/getting-started/upgrading","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Upgrading","description":"How to upgrade and migrate COSMOS","sidebar_custom_props":{"myEmoji":"\u2B06\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Getting Started","permalink":"/tools/staticdocs/docs/getting-started/gettingstarted"},"next":{"title":"Command Line Interface","permalink":"/tools/staticdocs/docs/getting-started/cli"}}'),i=o(2322),s=o(2840);let r={sidebar_position:4,title:"Upgrading",description:"How to upgrade and migrate COSMOS",sidebar_custom_props:{myEmoji:"\u2B06\uFE0F"}},l=void 0,a={},c=[{value:"COSMOS Upgrades",id:"cosmos-upgrades",level:2},{value:"Upgrade Migration Process",id:"upgrade-migration-process",level:3},{value:"Migrating From COSMOS 5 to COSMOS 6",id:"migrating-from-cosmos-5-to-cosmos-6",level:2},{value:"Updating Vue",id:"updating-vue",level:3},{value:"The quick and dirty way",id:"the-quick-and-dirty-way",level:4},{value:"Step 1: Vue compat mode",id:"step-1-vue-compat-mode",level:4},{value:"(1.a) Update dependencies",id:"1a-update-dependencies",level:5},{value:"(1.b) Update the Vue config file (<code>vue.config.js</code>)",id:"1b-update-the-vue-config-file-vueconfigjs",level:5},{value:"(1.c) Update the eslint config file (<code>.eslintrc</code>)",id:"1c-update-the-eslint-config-file-eslintrc",level:5},{value:"(1.d) Fix build and runtime warnings and errors",id:"1d-fix-build-and-runtime-warnings-and-errors",level:5},{value:"Step 2: Bump compat mode from 2 to 3",id:"step-2-bump-compat-mode-from-2-to-3",level:4},{value:"Step 3: Update Vuetify",id:"step-3-update-vuetify",level:4},{value:"Step 4: Clean up",id:"step-4-clean-up",level:4},{value:"Migrating to the new OpenC3 common packages",id:"migrating-to-the-new-openc3-common-packages",level:3},{value:"Step 1: Update dependencies",id:"step-1-update-dependencies",level:4},{value:"Step 2: Update imports in your code",id:"step-2-update-imports-in-your-code",level:4},{value:"<code>@openc3/js-common</code>",id:"openc3js-common",level:4},{value:"<code>@openc3/vue-common</code>",id:"openc3vue-common",level:4},{value:"Migrating From COSMOS 4 to COSMOS 5",id:"migrating-from-cosmos-4-to-cosmos-5",level:2},{value:"Configuration Migration Tool",id:"configuration-migration-tool",level:3},{value:"Upgrading Custom Tools",id:"upgrading-custom-tools",level:3}];function d(e){let n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"cosmos-upgrades",children:"COSMOS Upgrades"}),"\n",(0,i.jsx)(n.p,{children:"OpenC3 releases new versions of COSMOS on a monthy or better cadence. This is done for several reasons: to incorporate new features, fix existing bugs, update dependencies, and close CVEs. We extensively test each release at both the unit level, API level, and system level using Playwright against a deployed COSMOS. Thus we recommend upgrading COSMOS as quickly as possible when new releases become available. While COSMOS itself is tested extensively, we obviously can not test against customer plugins and custom deployments. We recommend having another installation of COSMOS which you can upgrade with your own plugins and verify functionality before upgrading your production environment."}),"\n",(0,i.jsx)(n.p,{children:"COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release."}),"\n",(0,i.jsx)(n.admonition,{title:"Release Notes",type:"info",children:(0,i.jsxs)(n.p,{children:["Always check the release notes associated with the release on the ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases",children:"releases"})," page. Sometimes there are migration notes."]})}),"\n",(0,i.jsx)(n.p,{children:"This example assumes an existing COSMOS project at C:\\cosmos-project."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Stop the current COSMOS application"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat stop\n"})}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Change the release in the .env file to the desired release"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-batch",children:"OPENC3_TAG=6.4.1\n"})}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Run the new COSMOS application"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat run\n"})}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"upgrade-migration-process",children:"Upgrade Migration Process"}),"\n",(0,i.jsxs)(n.p,{children:["COSMOS doesn't use strict ",(0,i.jsx)(n.a,{href:"https://semver.org/",children:"semantic versioning"})," for our releases. Our major releases (5.0.0, 6.0.0, etc) are for major architectural changes and backward incompatibilities. Minor releases (6.1.0, 6.2.0, etc) add functionality but can also modify our configuration files. Thus certain minor releases are more important than others when skipping releases."]}),"\n",(0,i.jsx)(n.p,{children:"The following table identifies key release milestones which should be incrementally upgraded to by following the linked release notes. Versions not listed can be safely skipped while upgrading. For example, upgrading COSMOS 5.9.0 can go straight to 5.13.0 at which point the release notes should be carefully followed to avoid breaking changes."}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{style:{textAlign:"left"},children:"Version"}),(0,i.jsx)(n.th,{style:{textAlign:"left"},children:"Summary"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{style:{textAlign:"left"},children:(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v5.13.0",children:"5.13.0"})}),(0,i.jsx)(n.td,{style:{textAlign:"left"},children:"Breaking change to non-root containers and renamed minio volume. Requires running the migration script and updating compose.yaml and traefik configuration."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{style:{textAlign:"left"},children:(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v5.15.0",children:"5.15.0"})}),(0,i.jsx)(n.td,{style:{textAlign:"left"},children:"The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments. Requires updating .env, compose.yaml, and traefik configuration."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{style:{textAlign:"left"},children:(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v6.0.0",children:"6.0.0"})}),(0,i.jsxs)(n.td,{style:{textAlign:"left"},children:["May require no changes but follow the ",(0,i.jsx)(n.a,{href:"upgrading#migrating-from-cosmos-5-to-cosmos-6",children:"COSMOS 6 migration guide"})," for custom GUI tools."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{style:{textAlign:"left"},children:(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v6.1.0",children:"6.1.0"})}),(0,i.jsx)(n.td,{style:{textAlign:"left"},children:"Changed from ActionCable to AnyCable which requires updates to compose.yaml, redis.acl, and traefik configuration. We also broke apart the COSMOS helm charts from a single chart to 3 charts."})]})]})]}),"\n",(0,i.jsxs)(n.admonition,{title:"Downgrades",type:"warning",children:[(0,i.jsx)(n.p,{children:"Downgrades are not necessarily supported. When upgrading COSMOS we need to upgrade databases and sometimes migrate internal data structures. While we perform a full regression test on every release, we recommend upgrading an individual machine with your specific plugins and do local testing before rolling out the upgrade to your production system."}),(0,i.jsxs)(n.p,{children:["In general, patch releases (x.y.Z) can be downgraded, minor releases (x.Y.z) ",(0,i.jsx)(n.em,{children:"might"})," be able to be downgraded and major releases (X.y.z) are NOT able to be downgraded."]})]}),"\n",(0,i.jsx)(n.h2,{id:"migrating-from-cosmos-5-to-cosmos-6",children:"Migrating From COSMOS 5 to COSMOS 6"}),"\n",(0,i.jsx)(n.admonition,{title:"Developers Only",type:"info",children:(0,i.jsx)(n.p,{children:"If you haven't written any custom tools or widgets, there are no special changes required to upgrade from COSMOS 5 to COSMOS 6. Simply follow the normal upgrade instructions above including following the release notes."})}),"\n",(0,i.jsxs)(n.p,{children:["COSMOS 6 introduces some breaking changes for custom tools regarding the Vue framework and our common library code. We've upgraded from Vue 2 (EOL December 31, 2023) to Vue 3. These versions of Vue are not compatible with each other, so any tools written with Vue 2 will need to be updated. Additionally, our ",(0,i.jsx)(n.code,{children:"@openc3/tool-common"})," NPM package has been deprecated with its functionality reorganized into two packages: ",(0,i.jsx)(n.code,{children:"@openc3/js-common"})," and ",(0,i.jsx)(n.code,{children:"@openc3/vue-common"}),". This is to provide a better experience for developers who are building COSMOS tools without the Vue framework."]}),"\n",(0,i.jsxs)(n.p,{children:["We also removed a few rarely used ",(0,i.jsx)(n.a,{href:"../guides/scripting-api#migration-from-cosmos-v5-to-v6",children:"API methods"})," in COSMOS 6."]}),"\n",(0,i.jsx)(n.h3,{id:"updating-vue",children:"Updating Vue"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.em,{children:"If your tool was not built with Vue (e.g. it was built without a frontend framework, or it was built with React, Angular, etc.), then you can skip this section."})}),"\n",(0,i.jsx)(n.h4,{id:"the-quick-and-dirty-way",children:"The quick and dirty way"}),"\n",(0,i.jsxs)(n.p,{children:["Tools that are relatively simple can probably be upgraded in one shot by just updating the dependencies and fixing any build errors that arise, and then fixing any runtime errors you find from testing and using your tool. If you're confident in this upgrade path, you can reference ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/pull/1747",children:"this pull request"})," to see what will need to change. Otherwise, the rest of this guide will walk you through a more in-depth and complete migration process."]}),"\n",(0,i.jsx)(n.h4,{id:"step-1-vue-compat-mode",children:"Step 1: Vue compat mode"}),"\n",(0,i.jsx)(n.p,{children:"The Vue team provided a compatibility mode to help with migrating from Vue 2 to Vue 3. This will let you get your tool up and running to make it easier to find the necessary changes."}),"\n",(0,i.jsx)(n.h5,{id:"1a-update-dependencies",children:"(1.a) Update dependencies"}),"\n",(0,i.jsx)(n.p,{children:'Use your package manager or edit the package.json file to update the following dependencies (ignore any packages marked "Update" that you aren\'t using)'}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Remove:"})," ",(0,i.jsx)(n.code,{children:"vue-template-compiler"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"@vue/compat"})," >= 3.5 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compat",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"@vue/compiler-sfc"})," >= 3.5 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compiler-sfc",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"@vue/test-utils"})," >= 2.4 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compiler-sfc",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"vue"})," >= 3.5 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/vue",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"vuex"})," >= 4.1 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/vuex",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"vue-router"})," >= 4.4 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/vue-router",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"vuetify"})," >= 3.7 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/vuetify",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Update:"})," ",(0,i.jsx)(n.code,{children:"single-spa-vue"})," >= 3.0 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/single-spa-vue",children:"npmjs.com"}),")"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Eslint will help call out changes you'll need to make to your code for the migration, so it's recommended to include eslint in your project if you haven't already. There are plenty of guides online that will explain how to do that. If you're using eslint, then make the additional changes to your tool's dependencies:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"eslint-plugin-vuetify"})," >= 2.5 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/eslint-plugin-vuetify",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"vue-eslint-parser"})," >= 9.4 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/vue-eslint-parser",children:"npmjs.com"}),")"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If you modified your package.json file manually, don't forget to ",(0,i.jsx)(n.code,{children:"yarn"})," or ",(0,i.jsx)(n.code,{children:"npm install"})," at your project's root to apply the changes."]}),"\n",(0,i.jsxs)(n.h5,{id:"1b-update-the-vue-config-file-vueconfigjs",children:["(1.b) Update the Vue config file (",(0,i.jsx)(n.code,{children:"vue.config.js"}),")"]}),"\n",(0,i.jsxs)(n.p,{children:["You likely have a ",(0,i.jsx)(n.code,{children:"chainWebpack"})," property in the object that's exported by this file which looks something like this (though your contents might vary)"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"chainWebpack: (config) => {\n  config.module\n    .rule('vue')\n    .use('vue-loader')\n    .tap((options) => {\n      return {\n        prettify: false,\n      }\n    })\n},\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Add a resolution alias for ",(0,i.jsx)(n.code,{children:"@vue/compat"})," to the top of this block and set the compiler to use the Vue 2 compat mode:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"chainWebpack: (config) => {\n  config.resolve.alias.set('vue', '@vue/compat') // Add this line\n  config.module\n    .rule('vue')\n    .use('vue-loader')\n    .tap((options) => {\n      return {\n        prettify: false,\n        compilerOptions: { // Add this block\n          compatConfig: {  //\n            MODE: 2,       //\n          },               //\n        },                 // to here\n      }\n    })\n},\n"})}),"\n",(0,i.jsxs)(n.h5,{id:"1c-update-the-eslint-config-file-eslintrc",children:["(1.c) Update the eslint config file (",(0,i.jsx)(n.code,{children:".eslintrc"}),")"]}),"\n",(0,i.jsxs)(n.p,{children:["Find the string ",(0,i.jsx)(n.code,{children:"'plugin:vue/essential'"})," in your ",(0,i.jsx)(n.code,{children:"extends"})," block and change it to ",(0,i.jsx)(n.code,{children:"'plugin:vue/vue3-essential'"}),". If you don't have that plugin in your ",(0,i.jsx)(n.code,{children:"extends"})," block, or you're missing that block entirely, then add this. It will help find breaking changes in how your code is using the Vue API."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"extends: [\n  'plugin:vue/vue3-essential', // change this from plugin:vue/essential\n  'plugin:prettier/recommended',\n  '@vue/prettier',\n],\n"})}),"\n",(0,i.jsx)(n.h5,{id:"1d-fix-build-and-runtime-warnings-and-errors",children:"(1.d) Fix build and runtime warnings and errors"}),"\n",(0,i.jsxs)(n.p,{children:["Run your linting and build scripts (e.g. ",(0,i.jsx)(n.code,{children:"yarn lint"})," and ",(0,i.jsx)(n.code,{children:"yarn build"}),"). The eslint plugin and Vue's compat mode will find the first set of code changes you need to address. Fix these lint/build errors until your project builds successfully."]}),"\n",(0,i.jsxs)(n.p,{children:["Once it builds, run your project like you would for development. It's recommended to serve it from a local dev server with ",(0,i.jsx)(n.code,{children:"yarn serve"})," and add it to the import map overrides in the browser. Test the functionality of your tool and address any Vue errors and warnings that get printed to the browser console in the dev tools. ",(0,i.jsxs)(n.em,{children:["(NOTE: On ",(0,i.jsx)(n.code,{children:"MODE: 2"})," - your first pass through this section - it's ok if your tool doesn't completely work yet. Just address the warnings and errors that are logged to the browser console. You'll get your tool completely working in the next step.)"]})]}),"\n",(0,i.jsxs)(n.p,{children:["From our experience migrating the COSMOS first-party tools, you'll most likely have to make changes to your ",(0,i.jsx)(n.code,{children:"main.js"})," and ",(0,i.jsx)(n.code,{children:"router.js"}),' files at a minimum. You can reference the PR mentioned above in the "The quick and dirty way" section above to see what we changed, or search the internet for Vue 2 -> Vue 3 migration guides if you need help addressing any warnings or errors.']}),"\n",(0,i.jsx)(n.h4,{id:"step-2-bump-compat-mode-from-2-to-3",children:"Step 2: Bump compat mode from 2 to 3"}),"\n",(0,i.jsxs)(n.p,{children:["Change the ",(0,i.jsx)(n.code,{children:"compatConfig"})," you added to your vue config file (",(0,i.jsx)(n.code,{children:"vue.config.js"}),") from ",(0,i.jsx)(n.code,{children:"MODE: 2"})," to ",(0,i.jsx)(n.code,{children:"MODE: 3"}),". This will tell Vue's compat mode that you've addressed the changes in the previous step, and it will find the next set of issues (since this is a multi-step process). Repeat the \"(1.d) Fix build and runtime warnings and errors\" step."]}),"\n",(0,i.jsx)(n.h4,{id:"step-3-update-vuetify",children:"Step 3: Update Vuetify"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.em,{children:"If you're not using Vuetify, you can skip this step."})}),"\n",(0,i.jsxs)(n.p,{children:["Modify your eslint config (",(0,i.jsx)(n.code,{children:".eslintrc"}),") again to add the Vuetify plugin:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"extends: [\n  'plugin:vue/vue3-essential',\n  'plugin:vuetify/base', // Add this line\n  'plugin:prettier/recommended',\n  '@vue/prettier',\n],\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," The Vuetify eslint plugin is only designed for migrating projects from Vuetify 2 to Vuetify 3 and can cause linting performance issues, so it should be removed once your tool migration is complete."]}),"\n",(0,i.jsxs)(n.p,{children:["Again in ",(0,i.jsx)(n.code,{children:".eslintrc"}),", find your ",(0,i.jsx)(n.code,{children:"parserOptions"})," block and add the ",(0,i.jsx)(n.code,{children:"parser"})," property above it:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"parser: 'vue-eslint-parser', // Add this line\nparserOptions: {\n  ...\n},\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now when you run eslint, it can tell you about any changes you'll need to address regarding how your code is using the Vuetify API. To find these changes, run eslint on your Vue files (e.g. ",(0,i.jsx)(n.code,{children:"yarn eslint . --ext .vue"}),"). You can address these manually, or if you trust eslint or have good version control, you can have the plugin fix most of them automatically with ",(0,i.jsx)(n.code,{children:"yarn eslint . --ext .vue --fix"})]}),"\n",(0,i.jsxs)(n.p,{children:["Lastly, if you are using the Astro UXDS icons via Vuetify from COSMOS - or any custom icon packs for that matter - then you'll need to change their pack alias format from ",(0,i.jsx)(n.code,{children:"$packName-"})," to ",(0,i.jsx)(n.code,{children:"packName:"}),". Here's an example for the ",(0,i.jsx)(n.code,{children:"antenna-transmit"})," Astro icon:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-html",children:"\x3c!-- Vue 2 / Vuetify 2 (old) --\x3e\n<v-icon> $astro-antenna-transmit </v-icon>\n\n\x3c!-- Vue 3 / Vuetify 3 (new) --\x3e\n<v-icon> astro:antenna-transmit </v-icon>\n"})}),"\n",(0,i.jsx)(n.h4,{id:"step-4-clean-up",children:"Step 4: Clean up"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Remove the ",(0,i.jsx)(n.code,{children:"@vue/compat"})," and ",(0,i.jsx)(n.code,{children:"eslint-plugin-vuetify"})," dependencies you added in step 1.a"]}),"\n",(0,i.jsxs)(n.li,{children:["Remove the ",(0,i.jsx)(n.code,{children:"compatConfig"})," you added in step 1.b"]}),"\n",(0,i.jsxs)(n.li,{children:["Remove the ",(0,i.jsx)(n.code,{children:"'plugin:vuetify/base'"})," you added in step 3"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"migrating-to-the-new-openc3-common-packages",children:"Migrating to the new OpenC3 common packages"}),"\n",(0,i.jsxs)(n.p,{children:["As mentioned in the first paragraph of this guide, we've deprecated the ",(0,i.jsx)(n.code,{children:"@openc3/tool-common"})," NPM package. All of its functionality has remained the same, but everything is organized differently, so you'll have to update your dependencies and imports."]}),"\n",(0,i.jsx)(n.h4,{id:"step-1-update-dependencies",children:"Step 1: Update dependencies"}),"\n",(0,i.jsx)(n.p,{children:"Use your package manager or edit the package.json file to update the following dependencies"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Remove:"})," ",(0,i.jsx)(n.code,{children:"@openc3/tool-common"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"@openc3/js-common"})," >= 6.0 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/@openc3/js-common",children:"npmjs.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Add:"})," ",(0,i.jsx)(n.code,{children:"@openc3/vue-common"})," >= 6.0 (",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/@openc3/vue-common",children:"npmjs.com"}),")","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"This is only needed if you are using our Vue stuff (components, plugins, etc.)"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"step-2-update-imports-in-your-code",children:"Step 2: Update imports in your code"}),"\n",(0,i.jsxs)(n.p,{children:["In COSMOS 5, things were imported directly from ",(0,i.jsx)(n.code,{children:"@openc3/tool-common"}),"'s ",(0,i.jsx)(n.code,{children:"src"})," directory and subsequently built into your tool by your build process. Everything in COSMOS 6 is now exported through several top-level exports in our new common packages. In general, the pattern is as follows:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["COSMOS 5: ",(0,i.jsx)(n.code,{children:"import bar from '@openc3/tool-common/src/foo/bar'"})]}),"\n",(0,i.jsxs)(n.li,{children:["COSMOS 6: ",(0,i.jsx)(n.code,{children:"import { bar } from '@openc3/vue-common/foo'"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["This pattern also lets you combine multiple import statements into one (e.g. ",(0,i.jsx)(n.code,{children:"import { bar, baz } from '@openc3/vue-common/foo'"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"There are three exceptions to this pattern:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Widgets are no longer under the ",(0,i.jsx)(n.code,{children:"components"})," directory but instead get their own top-level export","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Old: ",(0,i.jsx)(n.code,{children:"import foo from '@openc3/tool-common/src/components/widgets/Foo"})]}),"\n",(0,i.jsxs)(n.li,{children:["New: ",(0,i.jsx)(n.code,{children:"import { foo } from '@openc3/vue-common/widgets"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["Icons got the same treatment","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Old: ",(0,i.jsx)(n.code,{children:"import bar from '@openc3/tool-common/src/components/icons/Bar"})]}),"\n",(0,i.jsxs)(n.li,{children:["New: ",(0,i.jsx)(n.code,{children:"import { bar } from '@openc3/vue-common/icons"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["The ",(0,i.jsx)(n.code,{children:"TimeFilters"})," mixin was moved from ",(0,i.jsx)(n.code,{children:"tools/base"})," to ",(0,i.jsx)(n.code,{children:"util"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Old: ",(0,i.jsx)(n.code,{children:"import TimeFilters from '@openc3/tool-common/src/tools/base/util/timeFilters"})]}),"\n",(0,i.jsxs)(n.li,{children:["New: ",(0,i.jsx)(n.code,{children:"import { TimeFilters } from '@openc3/vue-common/util"})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openc3js-common",children:(0,i.jsx)(n.code,{children:"@openc3/js-common"})}),"\n",(0,i.jsxs)(n.p,{children:["This package contains things previously under ",(0,i.jsx)(n.code,{children:"@openc3/tool-common/src/services"}),". Anything not from that path will be in the ",(0,i.jsx)(n.code,{children:"vue-common"})," package discussed below."]}),"\n",(0,i.jsx)(n.p,{children:"Update any of your imports from that path accordingly. Here's an example:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:'// COSMOS 5 (old)\nimport Api from "@openc3/tool-common/src/services/api";\nimport Cable from "@openc3/tool-common/src/services/cable";\nimport { OpenC3Api } from "@openc3/tool-common/src/services/openc3Api";\n\n// COSMOS 6 (new)\nimport { Api, Cable, OpenC3Api } from "@openc3/js-common/services";\n'})}),"\n",(0,i.jsx)(n.p,{children:"This package also provides a couple more top-level imports which you likely will not need, but they might be useful, so I'll call them out here:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"import { prependBasePath } from '@openc3/js-common/utils"})," provides a function that will prepend the base path (e.g. localhost:2900) to Vue Router ",(0,i.jsx)(n.code,{children:"route"})," objects and their children. This can be useful if you run into certain quirks with single-spa and vue-router 4's routing logic where you need the full path. You can see how we use it ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/src/router.js#L76",children:"here"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"import { devServerPlugin } from '@openc3/js-common/viteDevServerPlugin"}),". This Vite plugin is a temporary hack to run a local dev server for tools when migrating from webpack/vue-cli. It should be replaced with Vite's built-in ",(0,i.jsx)(n.code,{children:"vite dev"})," dev server, but that's currently not working - at least in our first-party COSMOS tools. You can see how we use it ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/vite.config.js#L37",children:"here"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openc3vue-common",children:(0,i.jsx)(n.code,{children:"@openc3/vue-common"})}),"\n",(0,i.jsxs)(n.p,{children:["This package provides all the shared Vue components we use to build our first-party tools. The main top-level exports are ",(0,i.jsx)(n.code,{children:"components"}),", ",(0,i.jsx)(n.code,{children:"icons"}),", ",(0,i.jsx)(n.code,{children:"plugins"}),", ",(0,i.jsx)(n.code,{children:"util"}),", and ",(0,i.jsx)(n.code,{children:"widgets"}),". There are also some tool-specific exports that we built for code sharing with COSMOS Enterprise, which you might find useful: ",(0,i.jsx)(n.code,{children:"tool/base"}),", ",(0,i.jsx)(n.code,{children:"tool/admin"}),", and ",(0,i.jsx)(n.code,{children:"tool/calendar"}),". Here's an example, but again, reference the pattern mentioned above."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:'// COSMOS 5 (old)\nimport DetailsDialog from "@openc3/tool-common/src/components/DetailsDialog";\nimport Graph from "@openc3/tool-common/src/components/Graph";\nimport Notify from "@openc3/tool-common/src/plugins/notify";\nimport TimeFilters from "@openc3/tool-common/src/tools/base/util/timeFilters";\nimport VWidget from "@openc3/tool-common/src/components/widgets/VWidget";\n\n// COSMOS 6 (new)\nimport { DetailsDialog, Graph } from "@openc3/vue-common/components";\nimport { Notify } from "@openc3/vue-common/plugins";\nimport { TimeFilters } from "@openc3/vue-common/util";\nimport { VWidget } from "@openc3/vue-common/widgets";\n'})}),"\n",(0,i.jsx)(n.h2,{id:"migrating-from-cosmos-4-to-cosmos-5",children:"Migrating From COSMOS 4 to COSMOS 5"}),"\n",(0,i.jsx)(n.admonition,{title:"All COSMOS Users",type:"info",children:(0,i.jsx)(n.p,{children:"All COSMOS 4 users must upgrade their configuration to 5. However, the command, telemetry and screen definitions (keywords and syntax) have remained the same."})}),"\n",(0,i.jsxs)(n.p,{children:["COSMOS 5 is a new architecture and treats targets as independent ",(0,i.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/plugins",children:"plugins"}),". Thus the primary effort in porting from COSMOS 4 to COSMOS 5 is converting targets to plugins. We recommend creating plugins for each independent target (with its own interface) but targets which share an interface will need to be part of the same plugin. The reason for independent plugins is it allows the plugin to be versioned separately and more easily shared outside your specific project. If you have very project specific targets (e.g. custom hardware) those can potentially be combined for ease of deployment."]}),"\n",(0,i.jsx)(n.h3,{id:"configuration-migration-tool",children:"Configuration Migration Tool"}),"\n",(0,i.jsx)(n.p,{children:"COSMOS 5 (but not COSMOS 6) includes a migration tool for converting an existing COSMOS 4 configuration into a COSMOS 5 plugin. This example assumes an existing COSMOS 4 configuration at C:\\COSMOS and a new COSMOS 5 installation at C:\\cosmos-project. Linux users can adjust paths and change from .bat to .sh to follow along."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Change to the existing COSMOS 4 configuration directory. You should see the config, lib, procedures, outputs directory. You can then run the migration tool by specifying the absolute path to the COSMOS 5 installation."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate -a demo\n"})}),"\n",(0,i.jsx)(n.p,{children:"This creates a new COSMOS 5 plugin called openc3-cosmos-demo with a target named DEMO containing the existing lib and procedures files as well as all the existing targets."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate demo-part INST\n"})}),"\n",(0,i.jsx)(n.p,{children:"This would create a new COSMOS 5 plugin called openc3-cosmos-demo-part with a target named DEMO_PART containing the existing lib and procedures files as well as the INST target (but no others)."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Open the new COSMOS 5 plugin and ensure the ",(0,i.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/plugins#plugintxt-configuration-file",children:"plugin.txt"})," file is correctly configured. The migration tool doesn't create VARIABLEs or MICROSERVICEs or handle target substitution so those features will have to added manually."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Follow the ",(0,i.jsx)(n.a,{href:"/tools/staticdocs/docs/getting-started/gettingstarted#building-your-plugin",children:"building your plugin"})," part of the Getting Started tutorial to build your new plugin and upload it to COSMOS 5."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"upgrading-custom-tools",children:"Upgrading Custom Tools"}),"\n",(0,i.jsxs)(n.p,{children:["COSMOS 4 was a Qt Desktop based application. COSMOS 5 is a completely new architecture which runs natively in the browser using ",(0,i.jsx)(n.a,{href:"https://vuejs.org/",children:"Vue.js"})," as the Javascript framework and ",(0,i.jsx)(n.a,{href:"https://vuetifyjs.com/en/",children:"Vuetify"})," as the GUI library. We utilize ",(0,i.jsx)(n.a,{href:"https://single-spa.js.org/",children:"single-spa"})," to allow you to write COSMOS tool plugins in any language and provide ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3/templates",children:"templates"})," for Vue.js (recommended), Angular, React and Svelte. Any COSMOS 4 custom tools will have to be completely re-written to run in COSMOS 5. We recommend using the native COSMOS ",(0,i.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages",children:"tools"})," and finding GUI concepts and functionality that best match the tool you're trying to re-create."]}),"\n",(0,i.jsxs)(n.p,{children:["If you need custom development get in touch at ",(0,i.jsx)(n.a,{href:"mailto:sales@openc3.com",children:"sales@openc3.com"}),"."]})]})}function h(e={}){let{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}}}]);

data/tools/staticdocs/assets/js/7690.fc05b8e6.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["7690"],{2832:function(c,e,o){o.r(e)}}]);