openc3-cosmos-tool-docs 5.13.0 → 5.14.0

data/tools/staticdocs/assets/js/5b233ba7.37e9a690.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1784],{3657:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var s=o(2322),i=o(5392);const t={title:"Understanding Licenses"},l=void 0,r={id:"meta/licenses",title:"Understanding Licenses",description:"OpenC3 COSMOS is offered under a tri-licensing model allowing users to choose between the following three options:",source:"@site/docs/meta/licenses.md",sourceDirName:"meta",slug:"/meta/licenses",permalink:"/tools/staticdocs/docs/meta/licenses",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/meta/licenses.md",tags:[],version:"current",frontMatter:{title:"Understanding Licenses"},sidebar:"defaultSidebar",previous:{title:"Contributing",permalink:"/tools/staticdocs/docs/meta/contributing"},next:{title:"Philosophy",permalink:"/tools/staticdocs/docs/meta/philosophy"}},a={},c=[{value:"AGPLv3",id:"agplv3",level:2},{value:"Evaluation and Education Use Only",id:"evaluation-and-education-use-only",level:2},{value:"Commercial License",id:"commercial-license",level:2},{value:"Why you should buy a Commercial License",id:"why-you-should-buy-a-commercial-license",level:2}];function d(e){const n={a:"a",code:"code",em:"em",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"OpenC3 COSMOS is offered under a tri-licensing model allowing users to choose between the following three options:"}),"\n",(0,s.jsx)(n.h2,{id:"agplv3",children:"AGPLv3"}),"\n",(0,s.jsxs)(n.p,{children:["This is our default open source license and the license that most free users use. The AGPLv3 is a modification of the GPLv3 which is what is known as a copy-left license or a viral license. You can read the whole thing here: ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/blob/main/LICENSE.txt",children:"OpenC3 AGPLv3"})]}),"\n",(0,s.jsx)(n.p,{children:"Obviously, the actual license text applies, but here is a short summary:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"The AGPL allows users to use the code however they want: For business, personal, etc., as long as they follow the other terms:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"The software is provided as-is, no warranty"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Users must be given access to all the source code and are also allowed to use it however they want under the same terms of the AGPLv3. This includes any modifications made, anything added, and all plugins."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"For web applications (like COSMOS), a link must be provided to all of the source code."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"There are some key implications of the above:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You cannot keep anything proprietary from your users. They have the rights to take the code (and configuration) and do anything they want with it. You CANNOT impede these rights or you are violating the AGPLv3 and YOU lose the rights to use our software."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You must provide a digital link to all source code for your users, including plugins."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"All plugins must be licensed in an AGPLv3 compatible fashion. We recommend the MIT license because that allows your plugins to be compatible with the AGPLv3 and our commercial license. You can also use a dual license similar to what we do indicating the AGPLv3 or a purchased OpenC3 Commercial license."}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The AGPLv3 license is often chosen because it works well for open core products like COSMOS. Competitors cannot take the open source product and license it under different terms. They would be forever locked into the AGPLv3 which is difficult to monetize, because your customers can take any code you provide and publish it on the internet for free use by everyone."}),"\n",(0,s.jsx)(n.p,{children:"As the copyright holder, OpenC3 is able to license the product and derivatives commercially. No-one else can do this. (OpenC3 is also able to license legacy Ball Aerospace COSMOS code under IP agreement)"}),"\n",(0,s.jsx)(n.h2,{id:"evaluation-and-education-use-only",children:"Evaluation and Education Use Only"}),"\n",(0,s.jsxs)(n.p,{children:["This license takes effect as soon as you use any plugin we publish under Evaluation and Education terms. Currently the only plugin we use for this is our CCSDS CFDP plugin: ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/openc3-cosmos-cfdp",children:"CFDP Plugin"})]}),"\n",(0,s.jsx)(n.p,{children:"You can read the whole license here:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'# OpenC3 Evaluation and Educational License\n#\n# Copyright 2023 OpenC3, Inc.\n#\n# This work is licensed for evaluation and educational purposes only.\n# It may NOT be used for formal development, integration and test, operations\n# or any other commercial purpose without the purchase of a commercial license\n# from OpenC3, Inc.\n#\n# The above copyright notice and this permission notice shall be included in all copies\n# or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\n# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A\n# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\n# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n'})}),"\n",(0,s.jsx)(n.p,{children:"This license is pretty straight forward, but the key is you can't use this code for any real work leading to a product (Formal Development, Integration and Test, or Operations) unless you switch to purchasing a commercial license."}),"\n",(0,s.jsx)(n.h2,{id:"commercial-license",children:"Commercial License"}),"\n",(0,s.jsx)(n.p,{children:"This license is a signed contract with OpenC3. It allows use of our code for a program under contractual terms where you do not have to follow the AGPLv3."}),"\n",(0,s.jsx)(n.p,{children:"Generally we license to a specific project with terms that allow for unlimited users, and installs as needed by that project. Any code and plugins that you develop under the commercial license can be kept proprietary."}),"\n",(0,s.jsx)(n.p,{children:"These licenses are sold as yearly subscriptions, or as a non-expiring perpetual license. We also offer site licenses, and licenses to support unlimited missions on a government framework architecture."}),"\n",(0,s.jsx)(n.p,{children:"Of course with our commercial license, you also get all the extra functionality of our Enterprise product."}),"\n",(0,s.jsx)(n.h2,{id:"why-you-should-buy-a-commercial-license",children:"Why you should buy a Commercial License"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You want to save years and tens of millions of dollars developing the same functionality yourself."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You want all of the Enterprise functionality of COSMOS Enterprise Edition"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"User Accounts"}),"\n",(0,s.jsx)(n.li,{children:"Role Based Access Control"}),"\n",(0,s.jsx)(n.li,{children:"LDAP Support"}),"\n",(0,s.jsx)(n.li,{children:"Kubernetes Support"}),"\n",(0,s.jsx)(n.li,{children:"Cloud Deployment Configurations"}),"\n",(0,s.jsx)(n.li,{children:"The right to use CFDP and other Enterprise Only plugins"}),"\n",(0,s.jsx)(n.li,{children:"Grafana Support"}),"\n",(0,s.jsx)(n.li,{children:"Support from the COSMOS Developers"}),"\n",(0,s.jsxs)(n.li,{children:["Lots more - See our ",(0,s.jsx)(n.a,{href:"https://openc3.com/enterprise",children:"Enterprise"})," page"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You don't want to follow the AGPLv3"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"You want to keep the code and plugins you develop proprietary"}),"\n",(0,s.jsx)(n.li,{children:"You don't want to publish an accessible link to your source code"}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"You want to support the continued development and innovation of the COSMOS product"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.em,{children:"We appreciate all of our commercial customers. You make OpenC3 possible. Thank you."})})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},5392:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>l});var s=o(2784);const i={},t=s.createContext(i);function l(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/{5bc719f6.3f10a4f9.js → 5bc719f6.80666891.js}

@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1402],{5591:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var s=o(2322),t=o(5392);const a={sidebar_position:6,title:"Podman"},i=void 0,r={id:"getting-started/podman",title:"Podman",description:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",source:"@site/docs/getting-started/podman.md",sourceDirName:"getting-started",slug:"/getting-started/podman",permalink:"/tools/staticdocs/docs/getting-started/podman",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/podman.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6,title:"Podman"},sidebar:"defaultSidebar",previous:{title:"Requirements and Design",permalink:"/tools/staticdocs/docs/getting-started/requirements"},next:{title:"Configuration",permalink:"/tools/staticdocs/docs/configuration"}},c={},l=[{value:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",id:"openc3-cosmos-using-rootless-podman-and-docker-compose",level:3},{value:"MacOS Instructions",id:"macos-instructions",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h3,{id:"openc3-cosmos-using-rootless-podman-and-docker-compose",children:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose"}),"\n",(0,s.jsx)(n.admonition,{title:"Optional Installation Option",type:"info",children:(0,s.jsx)(n.p,{children:"These directions are for installing and running COSMOS using Podman instead of Docker. If you have Docker available, that is a simpler method."})}),"\n",(0,s.jsx)(n.p,{children:"Podman is an alternative container technology to Docker that is actively promoted by RedHat. The key benefit is that Podman can run without a root-level daemon service, making it significantly more secure by design, over standard Docker. However, it is a little more complicated to use. These directions will get you up and running with Podman. The following directions have been tested against RHEL 8.8, and RHEL 9.2, but should be similar on other operating systems."}),"\n",(0,s.jsx)(n.admonition,{title:"Rootless Podman Does Not Work (Directly) with NFS Home Directories",type:"warning",children:(0,s.jsxs)(n.p,{children:["NFS does not work for holding container storage due to issues with user ids and group ids. There are workarounds available but they all involve moving container storage to another location: either a different partition on the host local disk, or into a special mounted disk image. See: [",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/rootless-podman-nfs",children:"https://www.redhat.com/sysadmin/rootless-podman-nfs"}),"]",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/rootless-podman-nfs",children:"https://www.redhat.com/sysadmin/rootless-podman-nfs"}),"). Note that there is also a newish Podman setting that allows you to more easily change where the storage location is in /etc/containers/storage.conf called rootless_storage_path. See ",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/nfs-rootless-podman",children:"https://www.redhat.com/sysadmin/nfs-rootless-podman"})]})}),"\n",(0,s.jsx)(n.h1,{id:"redhat-88-and-92-instructions",children:"Redhat 8.8 and 9.2 Instructions"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install Prerequisite Packages"}),"\n",(0,s.jsx)(n.p,{children:"Note: This downloads and installs docker-compose from the latest 2.x release on Github. If your operating system has a docker-compose package, it will be easier to install using that instead. RHEL8 does not have a docker-compose package."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo yum update\nsudo yum install git podman-docker netavark\ncurl -SL https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-linux-x86_64 -o docker-compose\nsudo mv docker-compose /usr/local/bin/docker-compose\nsudo chmod +x /usr/local/bin/docker-compose\nsudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Configure Host OS for Redis"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo su\necho never > /sys/kernel/mm/transparent_hugepage/enabled\necho never > /sys/kernel/mm/transparent_hugepage/defrag\nsysctl -w vm.max_map_count=262144\nexit\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Configure Podman to use Netavark for DNS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo cp /usr/share/containers/containers.conf /etc/containers/.\nsudo vi /etc/containers/containers.conf\n"})}),"\n",(0,s.jsx)(n.p,{children:'Then edit the network_backend line to be "netavark" instead of "cni"'}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Start rootless podman socket service"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"systemctl enable --now --user podman.socket\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Put the following into your .bashrc file (or .bash_profile or whatever)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'export DOCKER_HOST="unix://$XDG_RUNTIME_DIR/podman/podman.sock"\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Source the profile file for your current terminal"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"source .bashrc\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Get COSMOS - A release or the current main branch (main branch shown)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/OpenC3/cosmos.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Optional - Set Default Container Registry"}),"\n",(0,s.jsx)(n.p,{children:"If you don't want podman to keep querying you for which registry to use, you can create a $HOME/.config/containers/registries.conf and modify to just have the main docker registry (or modify the /etc/containers/registries.conf file directly)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mkdir -p $HOME/.config/containers\ncp /etc/containers/registries.conf $HOME/.config/containers/.\nvi $HOME/.config/containers/registries.conf\n"})}),"\n",(0,s.jsx)(n.p,{children:"Then edit the unqualified-search-registries = line to just have the registry you care about (probably docker.io)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Edit cosmos/compose.yaml"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd cosmos\nvi compose.yaml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: ",(0,s.jsx)(n.code,{children:'"${OPENC3_USER_ID}:${OPENC3_GROUP_ID}"'})," lines.\nYou may also want to update the traefik configuration to allow access from the internet by removing 127.0.0.1 and probably switching to either an SSL config file, or the allow http one. Also make sure your firewall allows\nwhatever port you choose to use in. Rootless podman will need to use a higher numbered port (not 1-1023)."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Run COSMOS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"./openc3.sh run\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Wait until everything is built and running and then goto ",(0,s.jsx)(n.a,{href:"http://localhost:2900",children:"http://localhost:2900"})," in your browser"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{title:"Podman on MacOS",type:"info",children:(0,s.jsx)(n.p,{children:"Podman can also be used on MacOS, though we still generally recommend Docker Desktop"})}),"\n",(0,s.jsx)(n.h2,{id:"macos-instructions",children:"MacOS Instructions"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install podman"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"brew install podman\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Start the podman virtual machine"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"podman machine init\npodman machine start\n# Note: update to your username in the next line or copy paste from what 'podman machine start' says\nexport DOCKER_HOST='unix:///Users/ryanmelt/.local/share/containers/podman/machine/qemu/podman.sock'\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install docker-compose"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"brew install docker-compose # Optional if you already have Docker Desktop\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Edit cosmos/compose.yaml"}),"\n",(0,s.jsxs)(n.p,{children:["Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: ",(0,s.jsx)(n.code,{children:'"${OPENC3_USER_ID}:${OPENC3_GROUP_ID}"'})," lines."]}),"\n",(0,s.jsxs)(n.p,{children:["Important: on MacOS you must also remove all ",":z"," from the volume mount lines"]}),"\n",(0,s.jsx)(n.p,{children:"You may also want to update the traefik configuration to allow access from the internet."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Run COSMOS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd cosmos\n./openc3.sh run\n"})}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},5392:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>i});var s=o(2784);const t={},a=s.createContext(t);function i(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]);
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1402],{5591:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var s=o(2322),t=o(5392);const a={sidebar_position:7,title:"Podman"},i=void 0,r={id:"getting-started/podman",title:"Podman",description:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",source:"@site/docs/getting-started/podman.md",sourceDirName:"getting-started",slug:"/getting-started/podman",permalink:"/tools/staticdocs/docs/getting-started/podman",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/podman.md",tags:[],version:"current",sidebarPosition:7,frontMatter:{sidebar_position:7,title:"Podman"},sidebar:"defaultSidebar",previous:{title:"Requirements and Design",permalink:"/tools/staticdocs/docs/getting-started/requirements"},next:{title:"Configuration",permalink:"/tools/staticdocs/docs/configuration"}},c={},l=[{value:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",id:"openc3-cosmos-using-rootless-podman-and-docker-compose",level:3},{value:"MacOS Instructions",id:"macos-instructions",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h3,{id:"openc3-cosmos-using-rootless-podman-and-docker-compose",children:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose"}),"\n",(0,s.jsx)(n.admonition,{title:"Optional Installation Option",type:"info",children:(0,s.jsx)(n.p,{children:"These directions are for installing and running COSMOS using Podman instead of Docker. If you have Docker available, that is a simpler method."})}),"\n",(0,s.jsx)(n.p,{children:"Podman is an alternative container technology to Docker that is actively promoted by RedHat. The key benefit is that Podman can run without a root-level daemon service, making it significantly more secure by design, over standard Docker. However, it is a little more complicated to use. These directions will get you up and running with Podman. The following directions have been tested against RHEL 8.8, and RHEL 9.2, but should be similar on other operating systems."}),"\n",(0,s.jsx)(n.admonition,{title:"Rootless Podman Does Not Work (Directly) with NFS Home Directories",type:"warning",children:(0,s.jsxs)(n.p,{children:["NFS does not work for holding container storage due to issues with user ids and group ids. There are workarounds available but they all involve moving container storage to another location: either a different partition on the host local disk, or into a special mounted disk image. See: [",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/rootless-podman-nfs",children:"https://www.redhat.com/sysadmin/rootless-podman-nfs"}),"]",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/rootless-podman-nfs",children:"https://www.redhat.com/sysadmin/rootless-podman-nfs"}),"). Note that there is also a newish Podman setting that allows you to more easily change where the storage location is in /etc/containers/storage.conf called rootless_storage_path. See ",(0,s.jsx)(n.a,{href:"https://www.redhat.com/sysadmin/nfs-rootless-podman",children:"https://www.redhat.com/sysadmin/nfs-rootless-podman"})]})}),"\n",(0,s.jsx)(n.h1,{id:"redhat-88-and-92-instructions",children:"Redhat 8.8 and 9.2 Instructions"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install Prerequisite Packages"}),"\n",(0,s.jsx)(n.p,{children:"Note: This downloads and installs docker-compose from the latest 2.x release on Github. If your operating system has a docker-compose package, it will be easier to install using that instead. RHEL8 does not have a docker-compose package."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo yum update\nsudo yum install git podman-docker netavark\ncurl -SL https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-linux-x86_64 -o docker-compose\nsudo mv docker-compose /usr/local/bin/docker-compose\nsudo chmod +x /usr/local/bin/docker-compose\nsudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Configure Host OS for Redis"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo su\necho never > /sys/kernel/mm/transparent_hugepage/enabled\necho never > /sys/kernel/mm/transparent_hugepage/defrag\nsysctl -w vm.max_map_count=262144\nexit\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Configure Podman to use Netavark for DNS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"sudo cp /usr/share/containers/containers.conf /etc/containers/.\nsudo vi /etc/containers/containers.conf\n"})}),"\n",(0,s.jsx)(n.p,{children:'Then edit the network_backend line to be "netavark" instead of "cni"'}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Start rootless podman socket service"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"systemctl enable --now --user podman.socket\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Put the following into your .bashrc file (or .bash_profile or whatever)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'export DOCKER_HOST="unix://$XDG_RUNTIME_DIR/podman/podman.sock"\n'})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Source the profile file for your current terminal"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"source .bashrc\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Get COSMOS - A release or the current main branch (main branch shown)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/OpenC3/cosmos.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Optional - Set Default Container Registry"}),"\n",(0,s.jsx)(n.p,{children:"If you don't want podman to keep querying you for which registry to use, you can create a $HOME/.config/containers/registries.conf and modify to just have the main docker registry (or modify the /etc/containers/registries.conf file directly)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"mkdir -p $HOME/.config/containers\ncp /etc/containers/registries.conf $HOME/.config/containers/.\nvi $HOME/.config/containers/registries.conf\n"})}),"\n",(0,s.jsx)(n.p,{children:"Then edit the unqualified-search-registries = line to just have the registry you care about (probably docker.io)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Edit cosmos/compose.yaml"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd cosmos\nvi compose.yaml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: ",(0,s.jsx)(n.code,{children:'"${OPENC3_USER_ID}:${OPENC3_GROUP_ID}"'})," lines.\nYou may also want to update the traefik configuration to allow access from the internet by removing 127.0.0.1 and probably switching to either an SSL config file, or the allow http one. Also make sure your firewall allows\nwhatever port you choose to use in. Rootless podman will need to use a higher numbered port (not 1-1023)."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Run COSMOS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"./openc3.sh run\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Wait until everything is built and running and then goto ",(0,s.jsx)(n.a,{href:"http://localhost:2900",children:"http://localhost:2900"})," in your browser"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{title:"Podman on MacOS",type:"info",children:(0,s.jsx)(n.p,{children:"Podman can also be used on MacOS, though we still generally recommend Docker Desktop"})}),"\n",(0,s.jsx)(n.h2,{id:"macos-instructions",children:"MacOS Instructions"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install podman"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"brew install podman\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Start the podman virtual machine"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"podman machine init\npodman machine start\n# Note: update to your username in the next line or copy paste from what 'podman machine start' says\nexport DOCKER_HOST='unix:///Users/ryanmelt/.local/share/containers/podman/machine/qemu/podman.sock'\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Install docker-compose"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"brew install docker-compose # Optional if you already have Docker Desktop\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Edit cosmos/compose.yaml"}),"\n",(0,s.jsxs)(n.p,{children:["Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: ",(0,s.jsx)(n.code,{children:'"${OPENC3_USER_ID}:${OPENC3_GROUP_ID}"'})," lines."]}),"\n",(0,s.jsxs)(n.p,{children:["Important: on MacOS you must also remove all ",":z"," from the volume mount lines"]}),"\n",(0,s.jsx)(n.p,{children:"You may also want to update the traefik configuration to allow access from the internet."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Run COSMOS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd cosmos\n./openc3.sh run\n"})}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},5392:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>i});var s=o(2784);const t={},a=s.createContext(t);function i(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/5e3ed378.c40da631.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7052],{6157:(e,a,s)=>{s.r(a),s.d(a,{default:()=>x});s(2784);var c=s(489),n=s(328),i=s(211),r=s(913),l=s(1032),t=s(9589),d=s(5197);const o={mdxPageWrapper:"mdxPageWrapper_SLvB"};var m=s(2322);function x(e){const{content:a}=e,{metadata:{title:s,description:x,frontMatter:p,unlisted:g},assets:h}=a,{keywords:_,wrapperClassName:j,hide_table_of_contents:v}=p,u=h.image??p.image;return(0,m.jsx)(n.FG,{className:(0,c.Z)(j??i.k.wrapper.mdxPages,i.k.page.mdxPage),children:(0,m.jsxs)(r.Z,{children:[(0,m.jsx)(n.d,{title:s,description:x,keywords:_,image:u}),(0,m.jsx)("main",{className:"container container--fluid margin-vert--lg",children:(0,m.jsxs)("div",{className:(0,c.Z)("row",o.mdxPageWrapper),children:[(0,m.jsxs)("div",{className:(0,c.Z)("col",!v&&"col--8"),children:[g&&(0,m.jsx)(d.Z,{}),(0,m.jsx)("article",{children:(0,m.jsx)(l.Z,{children:(0,m.jsx)(a,{})})})]}),!v&&a.toc.length>0&&(0,m.jsx)("div",{className:"col col--2",children:(0,m.jsx)(t.Z,{toc:a.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level})})]})})]})})}}}]);

data/tools/staticdocs/assets/js/5fe211ef.9938cdb0.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4697],{6089:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>d,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>h});var r=n(2322),t=n(5392);const s={sidebar_position:8,title:"Tables"},d=void 0,l={id:"configuration/table",title:"Tables",description:"Table Definition Files",source:"@site/docs/configuration/table.md",sourceDirName:"configuration",slug:"/configuration/table",permalink:"/tools/staticdocs/docs/configuration/table",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/table.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,title:"Tables"},sidebar:"defaultSidebar",previous:{title:"Protocols",permalink:"/tools/staticdocs/docs/configuration/protocols"},next:{title:"Screens",permalink:"/tools/staticdocs/docs/configuration/telemetry-screens"}},a={},h=[{value:"Table Definition Files",id:"table-definition-files",level:2},{value:"TABLEFILE",id:"tablefile",level:2},{value:"TABLE",id:"table",level:2},{value:"TABLE Modifiers",id:"table-modifiers",level:2},{value:"PARAMETER",id:"parameter",level:3},{value:"PARAMETER Modifiers",id:"parameter-modifiers",level:3},{value:"FORMAT_STRING",id:"format_string",level:4},{value:"UNITS",id:"units",level:4},{value:"DESCRIPTION",id:"description",level:4},{value:"META",id:"meta",level:4},{value:"OVERLAP",id:"overlap",level:4},{value:"KEY",id:"key",level:4},{value:"REQUIRED",id:"required",level:4},{value:"MINIMUM_VALUE",id:"minimum_value",level:4},{value:"MAXIMUM_VALUE",id:"maximum_value",level:4},{value:"DEFAULT_VALUE",id:"default_value",level:4},{value:"STATE",id:"state",level:4},{value:"WRITE_CONVERSION",id:"write_conversion",level:4},{value:"POLY_WRITE_CONVERSION",id:"poly_write_conversion",level:4},{value:"SEG_POLY_WRITE_CONVERSION",id:"seg_poly_write_conversion",level:4},{value:"GENERIC_WRITE_CONVERSION_START",id:"generic_write_conversion_start",level:4},{value:"GENERIC_WRITE_CONVERSION_END",id:"generic_write_conversion_end",level:4},{value:"OVERFLOW",id:"overflow",level:4},{value:"HIDDEN",id:"hidden",level:4},{value:"UNEDITABLE",id:"uneditable",level:4},{value:"APPEND_PARAMETER",id:"append_parameter",level:3},{value:"SELECT_TABLE",id:"select_table",level:2},{value:"DEFAULT",id:"default",level:2},{value:"Example File",id:"example-file",level:2}];function c(e){const i={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h2,{id:"table-definition-files",children:"Table Definition Files"}),"\n",(0,r.jsxs)(i.p,{children:["Table definition files define the binary tables that can be displayed in COSMOS ",(0,r.jsx)(i.a,{href:"/tools/staticdocs/docs/tools/table-manager",children:"Table Manager"}),"\n. Table definitions are defined in the target's tables/config directory and are typically named after the table such as ",(0,r.jsx)(i.code,{children:"PPSSelectionTable_def.txt"}),". The ",(0,r.jsx)(i.code,{children:"_def.txt"})," extention helps to identify the file as a table definition. Table definitions can be combined using the ",(0,r.jsx)(i.code,{children:"TABLEFILE"})," keyword. This allows you to build individual table components into a larger binary."]}),"\n",(0,r.jsxs)(i.p,{children:["The Table definition files share a lot of similarity with the ",(0,r.jsx)(i.a,{href:"/tools/staticdocs/docs/configuration/command",children:"Command Configuration"}),". You have the same data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data."]}),"\n",(0,r.jsx)("div",{style:{clear:"both"}}),"\n",(0,r.jsx)(i.h1,{id:"table-keywords",children:"Table Keywords"}),"\n",(0,r.jsx)(i.h2,{id:"tablefile",children:"TABLEFILE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Specify another file to open and process for table definitions"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"File Name"}),(0,r.jsx)(i.td,{children:"Name of the file. The file will be looked for in the directory of the current definition file."}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h2,{id:"table",children:"TABLE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Start a new table definition"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Name"}),(0,r.jsx)(i.td,{children:"Name of the table in quotes. The name will appear on the GUI tab."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Endianness"}),(0,r.jsxs)(i.td,{children:["Indicates if the data in this table is 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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Display"}),(0,r.jsxs)(i.td,{children:["Indicates the table contains KEY_VALUE rows (e.g. each row is unique), or a ROW_COLUMN table with identical rows containing different values.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"KEY_VALUE, ROW_COLUMN"})]}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"When Display is KEY_VALUE the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description of the table in quotes. The description is used in mouseover popups and status line information."}),(0,r.jsx)(i.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(i.p,{children:"When Display is ROW_COLUMN the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Rows"}),(0,r.jsx)(i.td,{children:"The number of rows in the table"}),(0,r.jsx)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description of the table in quotes. The description is used in mouseover popups and status line information."}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.h2,{id:"table-modifiers",children:"TABLE Modifiers"}),"\n",(0,r.jsx)(i.p,{children:"The following keywords must follow a TABLE keyword."}),"\n",(0,r.jsx)(i.h3,{id:"parameter",children:"PARAMETER"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Defines a parameter in the current table"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Name"}),(0,r.jsx)(i.td,{children:"Name of the parameter. Must be unique within the table."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Bit Offset"}),(0,r.jsx)(i.td,{children:"Bit offset into the table of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the table. Always use a bit offset of 0 for derived parameters."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Bit Size"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Data Type"}),(0,r.jsxs)(i.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)(i.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Minimum Value"}),(0,r.jsx)(i.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Maximum Value"}),(0,r.jsx)(i.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Default Value"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Endianness"}),(0,r.jsxs)(i.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)(i.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)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Default Value"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Endianness"}),(0,r.jsxs)(i.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)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.h3,{id:"parameter-modifiers",children:"PARAMETER Modifiers"}),"\n",(0,r.jsx)(i.p,{children:"The following keywords must follow a PARAMETER keyword."}),"\n",(0,r.jsx)(i.h4,{id:"format_string",children:"FORMAT_STRING"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Adds printf style formatting"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Format"}),(0,r.jsx)(i.td,{children:"How to format using printf syntax. For example, '0x%0X' will display the value in hex."}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:'FORMAT_STRING "0x%0X"\n'})}),"\n",(0,r.jsx)(i.h4,{id:"units",children:"UNITS"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Add displayed units"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Full Name"}),(0,r.jsx)(i.td,{children:"Full name of the units type, e.g. Celsius"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Abbreviated"}),(0,r.jsx)(i.td,{children:"Abbreviation for the units, e.g. C"}),(0,r.jsx)(i.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"UNITS Celsius C\nUNITS Kilometers KM\n"})}),"\n",(0,r.jsx)(i.h4,{id:"description",children:"DESCRIPTION"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Override the defined description"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Value"}),(0,r.jsx)(i.td,{children:"The new description"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h4,{id:"meta",children:"META"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Stores custom user metadata"})}),"\n",(0,r.jsx)(i.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)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Meta Name"}),(0,r.jsx)(i.td,{children:"Name of the metadata to store"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Meta Values"}),(0,r.jsx)(i.td,{children:"One or more values to be stored for this Meta Name"}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:'META TEST "This parameter is for test purposes only"\n'})}),"\n",(0,r.jsx)(i.h4,{id:"overlap",children:"OVERLAP"}),"\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 4.4.1)"}),(0,r.jsx)(i.strong,{children:"This item is allowed to overlap other items in the packet"})]}),"\n",(0,r.jsx)(i.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 supresses the warning message."}),"\n",(0,r.jsx)(i.h4,{id:"key",children:"KEY"}),"\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,r.jsx)(i.strong,{children:"Defines the key used to access this raw value in the packet."})]}),"\n",(0,r.jsx)(i.p,{children:"Keys are often JsonPath or XPath strings"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Key string"}),(0,r.jsx)(i.td,{children:"The key to access this item"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"KEY $.book.title\n"})}),"\n",(0,r.jsx)(i.h4,{id:"required",children:"REQUIRED"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Parameter is required to be populated in scripts"})}),"\n",(0,r.jsx)(i.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)(i.h4,{id:"minimum_value",children:"MINIMUM_VALUE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Override the defined minimum value"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Value"}),(0,r.jsx)(i.td,{children:"The new minimum value for the parameter"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h4,{id:"maximum_value",children:"MAXIMUM_VALUE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Override the defined maximum value"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Value"}),(0,r.jsx)(i.td,{children:"The new maximum value for the parameter"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h4,{id:"default_value",children:"DEFAULT_VALUE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Override the defined default value"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Value"}),(0,r.jsx)(i.td,{children:"The new default value for the parameter"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h4,{id:"state",children:"STATE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Defines a key/value pair for the current command parameter"})}),"\n",(0,r.jsx)(i.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)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Key"}),(0,r.jsx)(i.td,{children:"The string state name"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Value"}),(0,r.jsx)(i.td,{children:"The numerical state value"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Hazardous / Disable Messages"}),(0,r.jsxs)(i.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)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Hazardous Description"}),(0,r.jsx)(i.td,{children:"String describing why this state is hazardous"}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.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)(i.h4,{id:"write_conversion",children:"WRITE_CONVERSION"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Applies a conversion when writing the current command parameter"})}),"\n",(0,r.jsx)(i.p,{children:"Conversions are implemented in a custom Ruby file which should be\nlocated in the target's lib folder. The class must require 'openc3/conversions/conversion'\nand inherit from Conversion. It must implement the initialize method if it\ntakes extra parameters and must always implement the 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."}),"\n",(0,r.jsx)(i.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,r.jsx)(i.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)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Class Filename"}),(0,r.jsx)(i.td,{children:"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Parameter"}),(0,r.jsx)(i.td,{children:"Additional parameter values for the conversion which are passed to the class constructor."}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"WRITE_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * multiplier\n    end\n  end\nend\n"})}),"\n",(0,r.jsx)(i.h4,{id:"poly_write_conversion",children:"POLY_WRITE_CONVERSION"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Adds a polynomial conversion factor to the current command parameter"})}),"\n",(0,r.jsx)(i.p,{children:"The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"C0"}),(0,r.jsx)(i.td,{children:"Coefficient"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Cx"}),(0,r.jsx)(i.td,{children:"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"POLY_WRITE_CONVERSION 10 0.5 0.25\n"})}),"\n",(0,r.jsx)(i.h4,{id:"seg_poly_write_conversion",children:"SEG_POLY_WRITE_CONVERSION"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Adds a segmented polynomial conversion factor to the current command parameter"})}),"\n",(0,r.jsx)(i.p,{children:"This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Lower Bound"}),(0,r.jsx)(i.td,{children:"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"C0"}),(0,r.jsx)(i.td,{children:"Coefficient"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Cx"}),(0,r.jsx)(i.td,{children:"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."}),(0,r.jsx)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n"})}),"\n",(0,r.jsx)(i.h4,{id:"generic_write_conversion_start",children:"GENERIC_WRITE_CONVERSION_START"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Start a generic write conversion"})}),"\n",(0,r.jsx)(i.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 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 ruby code given should return the converted\nvalue. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of\nruby code for the conversion have been given."}),"\n",(0,r.jsx)(i.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,r.jsx)(i.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)(i.admonition,{type:"warning",children:(0,r.jsx)(i.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)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n"})}),"\n",(0,r.jsx)(i.h4,{id:"generic_write_conversion_end",children:"GENERIC_WRITE_CONVERSION_END"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Complete a generic write conversion"})}),"\n",(0,r.jsx)(i.h4,{id:"overflow",children:"OVERFLOW"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Set the behavior when writing a value overflows the type"})}),"\n",(0,r.jsx)(i.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 writen, e.g. you can successfully write 255 to a 8 bit signed value."}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Behavior"}),(0,r.jsxs)(i.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)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:"OVERFLOW TRUNCATE\n"})}),"\n",(0,r.jsx)(i.h4,{id:"hidden",children:"HIDDEN"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Indicates that the parameter should not be shown to the user in the Table Manager GUI"})}),"\n",(0,r.jsx)(i.p,{children:"Hidden parameters still exist and will be saved to the resulting binary. This is useful for padding and other essential but non-user editable fields."}),"\n",(0,r.jsx)(i.h4,{id:"uneditable",children:"UNEDITABLE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Indicates that the parameter should be shown to the user but not editable."})}),"\n",(0,r.jsx)(i.p,{children:"Uneditable parameters are useful for control fields which the user may be interested in but should not be able to edit."}),"\n",(0,r.jsx)(i.h3,{id:"append_parameter",children:"APPEND_PARAMETER"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Defines a parameter in the current table"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Name"}),(0,r.jsx)(i.td,{children:"Name of the parameter. Must be unique within the table."}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Bit Size"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Data Type"}),(0,r.jsxs)(i.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)(i.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Minimum Value"}),(0,r.jsx)(i.td,{children:"Minimum allowed value for this parameter"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Maximum Value"}),(0,r.jsx)(i.td,{children:"Maximum allowed value for this parameter"}),(0,r.jsx)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Default Value"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Endianness"}),(0,r.jsxs)(i.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)(i.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)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsxs)(i.tbody,{children:[(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Default Value"}),(0,r.jsx)(i.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)(i.td,{children:"True"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Description"}),(0,r.jsx)(i.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,r.jsx)(i.td,{children:"False"})]}),(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Endianness"}),(0,r.jsxs)(i.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)(i.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(i.h2,{id:"select_table",children:"SELECT_TABLE"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Select an existing table for editing, typically done to override an existing definition"})}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Table"}),(0,r.jsx)(i.td,{children:"The name of the existin table"}),(0,r.jsx)(i.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(i.h2,{id:"default",children:"DEFAULT"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Specify default values for a SINGLE row in a multi-column table"})}),"\n",(0,r.jsx)(i.p,{children:"If you have multiple rows you need a DEFAULT line for each row. If all your rows are identical consider using ERB as shown in the OpenC3 demo."}),"\n",(0,r.jsxs)(i.table,{children:[(0,r.jsx)(i.thead,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.th,{children:"Parameter"}),(0,r.jsx)(i.th,{children:"Description"}),(0,r.jsx)(i.th,{children:"Required"})]})}),(0,r.jsx)(i.tbody,{children:(0,r.jsxs)(i.tr,{children:[(0,r.jsx)(i.td,{children:"Default values"}),(0,r.jsx)(i.td,{children:"A STATE value or data value corresponding to the data type"}),(0,r.jsx)(i.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(i.h2,{id:"example-file",children:"Example File"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.strong,{children:"Example File: TARGET/tables/config/MCConfigurationTable_def.txt"})}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-ruby",children:'TABLE "MC_Configuration" BIG_ENDIAN KEY_VALUE "Memory Control Configuration Table"\n  APPEND_PARAMETER "Scrub_Region_1_Start_Addr" 32 UINT 0 0x03FFFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_1_End_Addr" 32 UINT 0 0x03FFFFFF 0x03FFFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_Start_Addr" 32 UINT 0 0x03FFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_End_Addr" 32 UINT 0 0x03FFFFF 0x03FFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Dump_Packet_Throttle_(sec)" 32 UINT 0 0x0FFFFFFFF 2 "Number of seconds to wait between dumping large packets"\n  APPEND_PARAMETER "Memory_Scrubbing" 8 UINT 0 1 1\n    STATE DISABLE 0\n    STATE ENABLE 1\n  APPEND_PARAMETER "SIOC_Memory_Config" 8 UINT 1 3 3\n  APPEND_PARAMETER "Uneditable_Text" 32 UINT MIN MAX 0xDEADBEEF "Uneditable field"\n    FORMAT_STRING "0x%0X"\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_State" 16 UINT MIN MAX 0 "Uneditable field"\n    STATE DISABLE 0\n    STATE ENABLE 1\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_Check" 16 UINT MIN MAX 1 "Uneditable field"\n    STATE UNCHECKED 0\n    STATE CHECKED 1\n    UNEDITABLE\n  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"\n  APPEND_PARAMETER "Pad" 16 UINT 0 0 0\n    HIDDEN\n'})})]})}function o(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},5392:(e,i,n)=>{n.d(i,{Z:()=>l,a:()=>d});var r=n(2784);const t={},s=r.createContext(t);function d(e){const i=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),r.createElement(s.Provider,{value:i},e.children)}}}]);

data/tools/staticdocs/assets/js/6831b732.176e2062.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9227],{672:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var n=i(2322),s=i(5392);const t={sidebar_position:2,title:"Plugins"},l=void 0,d={id:"configuration/plugins",title:"Plugins",description:"Introduction",source:"@site/docs/configuration/plugins.md",sourceDirName:"configuration",slug:"/configuration/plugins",permalink:"/tools/staticdocs/docs/configuration/plugins",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2,title:"Plugins"},sidebar:"defaultSidebar",previous:{title:"File Format",permalink:"/tools/staticdocs/docs/configuration/format"},next:{title:"Targets",permalink:"/tools/staticdocs/docs/configuration/target"}},c={},h=[{value:"Introduction",id:"introduction",level:2},{value:"Concepts",id:"concepts",level:2},{value:"Target",id:"target",level:3},{value:"Interface",id:"interface",level:3},{value:"Router",id:"router",level:3},{value:"Tool",id:"tool",level:3},{value:"Microservice",id:"microservice",level:3},{value:"Plugin Directory Structure",id:"plugin-directory-structure",level:2},{value:"plugin.txt Configuration File",id:"plugintxt-configuration-file",level:2},{value:"VARIABLE",id:"variable",level:2},{value:"NEEDS_DEPENDENCIES",id:"needs_dependencies",level:2},{value:"INTERFACE",id:"interface-1",level:2},{value:"INTERFACE Modifiers",id:"interface-modifiers",level:2},{value:"MAP_TARGET",id:"map_target",level:3},{value:"MAP_CMD_TARGET",id:"map_cmd_target",level:3},{value:"MAP_TLM_TARGET",id:"map_tlm_target",level:3},{value:"DONT_CONNECT",id:"dont_connect",level:3},{value:"DONT_RECONNECT",id:"dont_reconnect",level:3},{value:"RECONNECT_DELAY",id:"reconnect_delay",level:3},{value:"DISABLE_DISCONNECT",id:"disable_disconnect",level:3},{value:"LOG_RAW",id:"log_raw",level:3},{value:"LOG_STREAM",id:"log_stream",level:3},{value:"PROTOCOL",id:"protocol",level:3},{value:"OPTION",id:"option",level:3},{value:"SECRET",id:"secret",level:3},{value:"ENV",id:"env",level:3},{value:"WORK_DIR",id:"work_dir",level:3},{value:"PORT",id:"port",level:3},{value:"CMD",id:"cmd",level:3},{value:"CONTAINER",id:"container",level:3},{value:"ROUTE_PREFIX",id:"route_prefix",level:3},{value:"ROUTER",id:"router-1",level:2},{value:"TARGET",id:"target-1",level:2},{value:"TARGET Modifiers",id:"target-modifiers",level:2},{value:"CMD_BUFFER_DEPTH",id:"cmd_buffer_depth",level:3},{value:"CMD_LOG_CYCLE_TIME",id:"cmd_log_cycle_time",level:3},{value:"CMD_LOG_CYCLE_SIZE",id:"cmd_log_cycle_size",level:3},{value:"CMD_LOG_RETAIN_TIME",id:"cmd_log_retain_time",level:3},{value:"CMD_DECOM_LOG_CYCLE_TIME",id:"cmd_decom_log_cycle_time",level:3},{value:"CMD_DECOM_LOG_CYCLE_SIZE",id:"cmd_decom_log_cycle_size",level:3},{value:"CMD_DECOM_LOG_RETAIN_TIME",id:"cmd_decom_log_retain_time",level:3},{value:"TLM_BUFFER_DEPTH",id:"tlm_buffer_depth",level:3},{value:"TLM_LOG_CYCLE_TIME",id:"tlm_log_cycle_time",level:3},{value:"TLM_LOG_CYCLE_SIZE",id:"tlm_log_cycle_size",level:3},{value:"TLM_LOG_RETAIN_TIME",id:"tlm_log_retain_time",level:3},{value:"TLM_DECOM_LOG_CYCLE_TIME",id:"tlm_decom_log_cycle_time",level:3},{value:"TLM_DECOM_LOG_CYCLE_SIZE",id:"tlm_decom_log_cycle_size",level:3},{value:"TLM_DECOM_LOG_RETAIN_TIME",id:"tlm_decom_log_retain_time",level:3},{value:"REDUCED_MINUTE_LOG_RETAIN_TIME",id:"reduced_minute_log_retain_time",level:3},{value:"REDUCED_HOUR_LOG_RETAIN_TIME",id:"reduced_hour_log_retain_time",level:3},{value:"REDUCED_DAY_LOG_RETAIN_TIME",id:"reduced_day_log_retain_time",level:3},{value:"LOG_RETAIN_TIME",id:"log_retain_time",level:3},{value:"REDUCED_LOG_RETAIN_TIME",id:"reduced_log_retain_time",level:3},{value:"CLEANUP_POLL_TIME",id:"cleanup_poll_time",level:3},{value:"REDUCER_DISABLE",id:"reducer_disable",level:3},{value:"REDUCER_MAX_CPU_UTILIZATION",id:"reducer_max_cpu_utilization",level:3},{value:"TARGET_MICROSERVICE",id:"target_microservice",level:3},{value:"PACKET",id:"packet",level:3},{value:"DISABLE_ERB",id:"disable_erb",level:3},{value:"MICROSERVICE",id:"microservice-1",level:2},{value:"MICROSERVICE Modifiers",id:"microservice-modifiers",level:2},{value:"ENV",id:"env-1",level:3},{value:"WORK_DIR",id:"work_dir-1",level:3},{value:"PORT",id:"port-1",level:3},{value:"TOPIC",id:"topic",level:3},{value:"TARGET_NAME",id:"target_name",level:3},{value:"CMD",id:"cmd-1",level:3},{value:"OPTION",id:"option-1",level:3},{value:"CONTAINER",id:"container-1",level:3},{value:"SECRET",id:"secret-1",level:3},{value:"ROUTE_PREFIX",id:"route_prefix-1",level:3},{value:"DISABLE_ERB",id:"disable_erb-1",level:3},{value:"TOOL",id:"tool-1",level:2},{value:"TOOL Modifiers",id:"tool-modifiers",level:2},{value:"URL",id:"url",level:3},{value:"INLINE_URL",id:"inline_url",level:3},{value:"WINDOW",id:"window",level:3},{value:"ICON",id:"icon",level:3},{value:"CATEGORY",id:"category",level:3},{value:"SHOWN",id:"shown",level:3},{value:"POSITION",id:"position",level:3},{value:"DISABLE_ERB",id:"disable_erb-2",level:3},{value:"WIDGET",id:"widget",level:2},{value:"WIDGET Modifiers",id:"widget-modifiers",level:2},{value:"DISABLE_ERB",id:"disable_erb-3",level:3}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h2,{id:"introduction",children:"Introduction"}),"\n",(0,n.jsx)(r.p,{children:"This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS."}),"\n",(0,n.jsx)(r.p,{children:"Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality."}),"\n",(0,n.jsx)(r.p,{children:"Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains."}),"\n",(0,n.jsx)(r.h2,{id:"concepts",children:"Concepts"}),"\n",(0,n.jsx)(r.h3,{id:"target",children:"Target"}),"\n",(0,n.jsx)(r.p,{children:"Targets are the external pieces of hardware and/or software that COSMOS communicates with. These are things like Front End Processors (FEPs), ground support equipment (GSE), custom software tools, and pieces of hardware like satellites themselves. A target is anything that COSMOS can send commands to and receive telemetry from."}),"\n",(0,n.jsx)(r.h3,{id:"interface",children:"Interface"}),"\n",(0,n.jsx)(r.p,{children:"Interfaces implement the physical connection to one or more targets. They are typically ethernet connections implemented using TCP or UDP but can be other connections like serial ports. Interfaces send commands to targets and receive telemetry from targets."}),"\n",(0,n.jsx)(r.h3,{id:"router",children:"Router"}),"\n",(0,n.jsx)(r.p,{children:"Routers flow streams of telemetry packets out of COSMOS and receive streams of commands into COSMOS. The commands are forwarded by COSMOS to associated interfaces. Telemetry comes from associated interfaces."}),"\n",(0,n.jsx)(r.h3,{id:"tool",children:"Tool"}),"\n",(0,n.jsx)(r.p,{children:"COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts."}),"\n",(0,n.jsx)(r.h3,{id:"microservice",children:"Microservice"}),"\n",(0,n.jsx)(r.p,{children:"Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks."}),"\n",(0,n.jsx)(r.h2,{id:"plugin-directory-structure",children:"Plugin Directory Structure"}),"\n",(0,n.jsxs)(r.p,{children:["COSMOS plugins have a well-defined directory structure described in detail in the ",(0,n.jsx)(r.a,{href:"../getting-started/generators",children:"Code Generator"})," documentation."]}),"\n",(0,n.jsx)(r.h2,{id:"plugintxt-configuration-file",children:"plugin.txt Configuration File"}),"\n",(0,n.jsx)(r.p,{children:"A plugin.txt configuration file is required for any COSMOS plugin. It declares the contents of the plugin and provides variables that allow the plugin to be configured at the time it is initially installed or upgraded.\nThis file follows the standard COSMOS configuration file format of keywords followed by zero or more space separated parameters. The following keywords are supported by the plugin.txt config file:"}),"\n",(0,n.jsx)(r.h2,{id:"variable",children:"VARIABLE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a configurable variable for the plugin"})}),"\n",(0,n.jsx)(r.p,{children:"The VARIABLE keyword defines a variable that will be requested for the user to enter during plugin installation.   Variables can be used to handle details of targets that are user defined such as specific IP addresses and ports.  Variables should also be used to allow users to rename targets to whatever name they want and support multiple installations of the same target with different names. Variables can be used later in plugin.txt or in any other configuration file included in a plugin using Ruby ERB syntax.  The variables are assigned to accessible local variables in the file. At a high level, ERB allows you to run Ruby code in configuration files."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Variable Name"}),(0,n.jsx)(r.td,{children:"The name of the variable"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Default Value"}),(0,n.jsx)(r.td,{children:"Default value of the variable"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.h2,{id:"needs_dependencies",children:"NEEDS_DEPENDENCIES"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.0)"}),(0,n.jsx)(r.strong,{children:"Indicates the plugin needs dependencies and sets the GEM_HOME environment variable"})]}),"\n",(0,n.jsx)(r.p,{children:"If the plugin has a top level lib folder or lists runtime dependencies in the gemspec, NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod."}),"\n",(0,n.jsx)(r.h2,{id:"interface-1",children:"INTERFACE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a connection to a physical target"})}),"\n",(0,n.jsx)(r.p,{children:"Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Interface Name"}),(0,n.jsx)(r.td,{children:"Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with '_INT' appended to the name, e.g. INST_INT for the INST target."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Filename"}),(0,n.jsxs)(r.td,{children:["Ruby file to use when instantiating the interface.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb"})]}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsxs)(r.p,{children:["Additional parameters are required. Please see the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/interfaces",children:"Interfaces"})," documentation for more details."]}),"\n",(0,n.jsx)(r.h2,{id:"interface-modifiers",children:"INTERFACE Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a INTERFACE keyword."}),"\n",(0,n.jsx)(r.h3,{id:"map_target",children:"MAP_TARGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Maps a target name to an interface"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TARGET DATA\n"})}),"\n",(0,n.jsx)(r.h3,{id:"map_cmd_target",children:"MAP_CMD_TARGET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Maps a target name to an interface for commands only"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Command target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface\n"})}),"\n",(0,n.jsx)(r.h3,{id:"map_tlm_target",children:"MAP_TLM_TARGET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Maps a target name to an interface for telemetry only"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Telemetry target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface\n"})}),"\n",(0,n.jsx)(r.h3,{id:"dont_connect",children:"DONT_CONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Server will not automatically try to connect to the interface at startup"})}),"\n",(0,n.jsx)(r.h3,{id:"dont_reconnect",children:"DONT_RECONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Server will not try to reconnect to the interface if the connection is lost"})}),"\n",(0,n.jsx)(r.h3,{id:"reconnect_delay",children:"RECONNECT_DELAY"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Reconnect delay in seconds"})}),"\n",(0,n.jsx)(r.p,{children:"If DONT_RECONNECT is not present the Server will try to reconnect to an interface if the connection is lost. Reconnect delay sets the interval in seconds between reconnect tries."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Delay"}),(0,n.jsx)(r.td,{children:"Delay in seconds between reconnect attempts. The default is 15 seconds."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_disconnect",children:"DISABLE_DISCONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Disable the Disconnect button on the Interfaces tab in the Server"})}),"\n",(0,n.jsx)(r.p,{children:"Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a 'production' environment where you would not want the user to inadvertantly disconnect from a target."}),"\n",(0,n.jsx)(r.h3,{id:"log_raw",children:"LOG_RAW"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Deprecated, use LOG_STREAM"})}),"\n",(0,n.jsx)(r.h3,{id:"log_stream",children:"LOG_STREAM"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.2)"}),(0,n.jsx)(r.strong,{children:"Log all data on the interface exactly as it is sent and received"})]}),"\n",(0,n.jsx)(r.p,{children:"LOG_STREAM does not add any OpenC3 headers and thus can not be read by OpenC3 tools. It is primarily useful for low level debugging of an interface. You will have to manually parse these logs yourself using a hex editor or other application."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Time"}),(0,n.jsx)(r.td,{children:"Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Size"}),(0,n.jsx)(r.td,{children:"Amount of data to write before cycling the log file. Default is 50MB."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Hour"}),(0,n.jsx)(r.td,{children:"The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Minute"}),(0,n.jsx)(r.td,{children:"See Cycle Hour."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE EXAMPLE example_interface.rb\n  # Override the default log time of 600\n  LOG_STREAM 60\n"})}),"\n",(0,n.jsx)(r.h3,{id:"protocol",children:"PROTOCOL"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 4.0.0)"}),(0,n.jsx)(r.strong,{children:"Protocols modify the interface by processing the data"})]}),"\n",(0,n.jsxs)(r.p,{children:["Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{})," For information on creating your own custom protocol please see ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/protocols",children:"Protocols"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsxs)(r.td,{children:["Whether to apply the protocol on incoming data, outgoing data, or both",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"READ, WRITE, READ_WRITE"})]}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol Filename or Classname"}),(0,n.jsx)(r.td,{children:"Ruby filename or class name which implements the protocol"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol specific parameters"}),(0,n.jsx)(r.td,{children:"Additional parameters used by the protocol"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil\n  MAP_TARGET DATA\n  # Rather than defining the LENGTH protocol on the INTERFACE line we define it here\n  PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11\nINTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TARGET DATA\n  PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets\n"})}),"\n",(0,n.jsx)(r.h3,{id:"option",children:"OPTION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set a parameter on an interface"})}),"\n",(0,n.jsx)(r.p,{children:"When an option is set the interface class calls the set_option method. Custom interfaces can override set_option to handle any additional options they want."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0)."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Parameters"}),(0,n.jsx)(r.td,{children:"Parameters to pass to the option"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil\n  OPTION FLOW_CONTROL RTSCTS\n  OPTION DATA_BITS 8\n"})}),"\n",(0,n.jsx)(r.h3,{id:"secret",children:"SECRET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.3.0)"}),(0,n.jsx)(r.strong,{children:"Define a secret needed by this interface"})]}),"\n",(0,n.jsx)(r.p,{children:"Defines a secret for this interface and optionally assigns its value to an option"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Name"}),(0,n.jsx)(r.td,{children:"The name of the secret to retrieve"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Environment Variable or File Path"}),(0,n.jsx)(r.td,{children:"Environment variable name or file path to store secret"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Name"}),(0,n.jsx)(r.td,{children:"Interface option to pass the secret value"}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Store Name"}),(0,n.jsx)(r.td,{children:"Name of the secret store for stores with multipart keys"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:'SECRET ENV USERNAME ENV_USERNAME USERNAME\nSECRET FILE KEY "/tmp/DATA/cert" KEY\n'})}),"\n",(0,n.jsx)(r.h3,{id:"env",children:"ENV"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Sets an environment variable in the microservice."})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Key"}),(0,n.jsx)(r.td,{children:"Environment variable name"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Value"}),(0,n.jsx)(r.td,{children:"Environment variable value"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"ENV COMPANY OpenC3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"work_dir",children:"WORK_DIR"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Set the working directory"})]}),"\n",(0,n.jsx)(r.p,{children:"Working directory to run the microservice CMD in.  Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Directory"}),(0,n.jsx)(r.td,{children:"Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"WORK_DIR '/openc3/lib/openc3/microservices'\n"})}),"\n",(0,n.jsx)(r.h3,{id:"port",children:"PORT"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Open port for the microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Number"}),(0,n.jsx)(r.td,{children:"Port number"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol"}),(0,n.jsx)(r.td,{children:"Port protocol. Default is TCP."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"PORT 7272\n"})}),"\n",(0,n.jsx)(r.h3,{id:"cmd",children:"CMD"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Command line to execute to run the microservice."})]}),"\n",(0,n.jsx)(r.p,{children:"Command line to execute to run the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"One or more arguments to exec to run the microservice."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"container",children:"CONTAINER"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Docker Container"})]}),"\n",(0,n.jsx)(r.p,{children:"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"Name of the container"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"route_prefix",children:"ROUTE_PREFIX"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Prefix of route"})]}),"\n",(0,n.jsx)(r.p,{children:"Prefix of route to the microservice to expose externally with Traefik"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Route Prefix"}),(0,n.jsx)(r.td,{children:"Route prefix. Must be unique across all scopes. Something like /myprefix"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"ROUTE_PREFIX /interface\n"})}),"\n",(0,n.jsx)(r.h2,{id:"router-1",children:"ROUTER"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Create router to receive commands and output telemetry packets from one or more interfaces"})}),"\n",(0,n.jsx)(r.p,{children:"Creates an router which receives command packets from their remote clients and sends them to associated interfaces. They receive telemetry packets from their interfaces and send them to their remote clients. This allows routers to be intermediaries between an external client and an actual device."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"Name of the router"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Filename"}),(0,n.jsxs)(r.td,{children:["Ruby file to use when instantiating the interface.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb"})]}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsxs)(r.p,{children:["Additional parameters are required. Please see the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/interfaces",children:"Interfaces"})," documentation for more details."]}),"\n",(0,n.jsx)(r.h2,{id:"target-1",children:"TARGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a new target"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Folder Name"}),(0,n.jsx)(r.td,{children:"The target folder"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder."}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"TARGET INST INST\n"})}),"\n",(0,n.jsx)(r.h2,{id:"target-modifiers",children:"TARGET Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a TARGET keyword."}),"\n",(0,n.jsx)(r.h3,{id:"cmd_buffer_depth",children:"CMD_BUFFER_DEPTH"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Number of commands to buffer to ensure logged in order"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Buffer Depth"}),(0,n.jsx)(r.td,{children:"Buffer depth in packets (Default = 5)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_cycle_time",children:"CMD_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command binary logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_cycle_size",children:"CMD_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command binary logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_retain_time",children:"CMD_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep raw command logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep raw command logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_cycle_time",children:"CMD_DECOM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command decommutation logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_cycle_size",children:"CMD_DECOM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command decommutation logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_retain_time",children:"CMD_DECOM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep decom command logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep decom command logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_buffer_depth",children:"TLM_BUFFER_DEPTH"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Number of telemetry packets to buffer to ensure logged in order"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Buffer Depth"}),(0,n.jsx)(r.td,{children:"Buffer depth in packets (Default = 60)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_cycle_time",children:"TLM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry binary logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_cycle_size",children:"TLM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry binary logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_retain_time",children:"TLM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep raw telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep raw telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_cycle_time",children:"TLM_DECOM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry decommutation logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_cycle_size",children:"TLM_DECOM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry decommutation logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_retain_time",children:"TLM_DECOM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep decom telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep decom telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_minute_log_retain_time",children:"REDUCED_MINUTE_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced minute telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_hour_log_retain_time",children:"REDUCED_HOUR_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced hour telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_day_log_retain_time",children:"REDUCED_DAY_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced day telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced day telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"log_retain_time",children:"LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep all regular telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep all regular telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_log_retain_time",children:"REDUCED_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep all reduced telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep all reduced telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cleanup_poll_time",children:"CLEANUP_POLL_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Period at which to run the cleanup process."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reducer_disable",children:"REDUCER_DISABLE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Disables the data reduction microservice for the target"})}),"\n",(0,n.jsx)(r.h3,{id:"reducer_max_cpu_utilization",children:"REDUCER_MAX_CPU_UTILIZATION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Maximum amount of CPU utilization to apply to data reduction"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Percentage"}),(0,n.jsx)(r.td,{children:"0 to 100 percent (default = 30)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"target_microservice",children:"TARGET_MICROSERVICE"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Breaks a target microservice out into its own process."})]}),"\n",(0,n.jsx)(r.p,{children:"Can be used to give more resources to processing that is falling behind. If defined multiple times for the same type, will create multiple processes. Each process can be given specific packets to process with the PACKET keyword."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"packet",children:"PACKET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Packet Name to allocate to the current TARGET_MICROSERVICE."})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Packet Name"}),(0,n.jsx)(r.td,{children:"The packet name. Does not apply to REDUCER or CLEANUP target microservice types."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire target or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"microservice-1",children:"MICROSERVICE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a new microservice"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Microservice Folder Name"}),(0,n.jsx)(r.td,{children:"The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Microservice Name"}),(0,n.jsx)(r.td,{children:"The specific name of this instance of the microservice in the OpenC3 system"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n"})}),"\n",(0,n.jsx)(r.h2,{id:"microservice-modifiers",children:"MICROSERVICE Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a MICROSERVICE keyword."}),"\n",(0,n.jsx)(r.h3,{id:"env-1",children:"ENV"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Sets an environment variable in the microservice."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Key"}),(0,n.jsx)(r.td,{children:"Environment variable name"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Value"}),(0,n.jsx)(r.td,{children:"Environment variable value"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  ENV COMPANY OpenC3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"work_dir-1",children:"WORK_DIR"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set the working directory"})}),"\n",(0,n.jsx)(r.p,{children:"Working directory to run the microservice CMD in.  Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Directory"}),(0,n.jsx)(r.td,{children:"Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  WORK_DIR .\n"})}),"\n",(0,n.jsx)(r.h3,{id:"port-1",children:"PORT"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,n.jsx)(r.strong,{children:"Open port for the microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Number"}),(0,n.jsx)(r.td,{children:"Port number"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol"}),(0,n.jsx)(r.td,{children:"Port protocol. Default is TCP."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  PORT 7272\n"})}),"\n",(0,n.jsx)(r.h3,{id:"topic",children:"TOPIC"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Associate a Redis topic"})}),"\n",(0,n.jsx)(r.p,{children:"Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Topic Name"}),(0,n.jsx)(r.td,{children:"Redis Topic to associate with the microservice"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  # Manually assigning topics is an advanced topic and requires\n  # intimate knowledge of the internal COSMOS data structures.\n  TOPIC DEFAULT__openc3_log_messages\n  TOPIC DEFAULT__TELEMETRY__EXAMPLE__STATUS\n"})}),"\n",(0,n.jsx)(r.h3,{id:"target_name",children:"TARGET_NAME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Associate a OpenC3 target"})}),"\n",(0,n.jsx)(r.p,{children:"OpenC3 target to associate with the microservice. For standard OpenC3 microservices such as decom_microservice this causes the target configuration to get loaded into the container for the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"OpenC3 target to associate with the microservice"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  TARGET_NAME EXAMPLE\n"})}),"\n",(0,n.jsx)(r.h3,{id:"cmd-1",children:"CMD"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command line to execute to run the microservice."})}),"\n",(0,n.jsx)(r.p,{children:"Command line to execute to run the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"One or more arguments to exec to run the microservice."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  CMD ruby example_target.rb\n"})}),"\n",(0,n.jsx)(r.h3,{id:"option-1",children:"OPTION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Pass an option to the microservice"})}),"\n",(0,n.jsx)(r.p,{children:"Generic key/value(s) options to pass to the microservice. These take the form of KEYWORD/PARAMS like a line in a OpenC3 configuration file. Multiple OPTION keywords can be used to pass multiple options to the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Name"}),(0,n.jsx)(r.td,{children:"Name of the option"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Value(s)"}),(0,n.jsx)(r.td,{children:"One or more values to associate with the option"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.h3,{id:"container-1",children:"CONTAINER"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Docker Container"})}),"\n",(0,n.jsx)(r.p,{children:"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"Name of the container"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"secret-1",children:"SECRET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.3.0)"}),(0,n.jsx)(r.strong,{children:"Define a secret needed by this microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Defines a secret for this microservice"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Name"}),(0,n.jsx)(r.td,{children:"The name of the secret to retrieve"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Environment Variable or File Path"}),(0,n.jsx)(r.td,{children:"Environment variable name or file path to store secret"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Store Name"}),(0,n.jsx)(r.td,{children:"Name of the secret store for stores with multipart keys"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:'SECRET ENV USERNAME ENV_USERNAME\nSECRET FILE KEY "/tmp/DATA/cert"\n'})}),"\n",(0,n.jsx)(r.h3,{id:"route_prefix-1",children:"ROUTE_PREFIX"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.0)"}),(0,n.jsx)(r.strong,{children:"Prefix of route"})]}),"\n",(0,n.jsx)(r.p,{children:"Prefix of route to the microservice to expose externally with Traefik"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Route Prefix"}),(0,n.jsx)(r.td,{children:"Route prefix. Must be unique across all scopes. Something like /myprefix"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE CFDP CFDP\n  ROUTE_PREFIX /cfdp\n"})}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-1",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire microservice or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"tool-1",children:"TOOL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a tool"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a tool that the plugin adds to the OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Tool Folder Name"}),(0,n.jsx)(r.td,{children:"The exact name of the tool folder in the plugin. ie. tools/ToolFolderName"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Tool Name"}),(0,n.jsx)(r.td,{children:"Name of the tool that is displayed in the OpenC3 Navigation menu"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"TOOL DEMO Demo\n"})}),"\n",(0,n.jsx)(r.h2,{id:"tool-modifiers",children:"TOOL Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a TOOL keyword."}),"\n",(0,n.jsx)(r.h3,{id:"url",children:"URL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Url used to access the tool"})}),"\n",(0,n.jsx)(r.p,{children:'The relative url used to access the tool. Defaults to "/tools/ToolFolderName".'}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Url"}),(0,n.jsx)(r.td,{children:"The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"inline_url",children:"INLINE_URL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Internal url to load a tool"})}),"\n",(0,n.jsx)(r.p,{children:'The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".'}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Url"}),(0,n.jsx)(r.td,{children:"The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"window",children:"WINDOW"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How to display the tool when navigated to"})}),"\n",(0,n.jsx)(r.p,{children:"The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within OpenC3. NEW opens the tool in a new TAB."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Window Mode"}),(0,n.jsxs)(r.td,{children:["Tool display mode",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"INLINE, IFRAME, NEW"})]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"icon",children:"ICON"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set tool icon"})}),"\n",(0,n.jsx)(r.p,{children:"Icon shown next to the tool name in the OpenC3 navigation menu."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Icon Name"}),(0,n.jsxs)(r.td,{children:["Icon to display next to the tool name. Icons come from Font Awesome, Material Design (",(0,n.jsx)(r.a,{href:"https://materialdesignicons.com/",children:"https://materialdesignicons.com/"}),"), and Astro."]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"category",children:"CATEGORY"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Category for the tool"})}),"\n",(0,n.jsx)(r.p,{children:"Associates the tool with a category which becomes a submenu in the Navigation menu."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Category Name"}),(0,n.jsx)(r.td,{children:"Category to associate the tool with"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"shown",children:"SHOWN"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Show the tool or not"})}),"\n",(0,n.jsx)(r.p,{children:"Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Shown"}),(0,n.jsxs)(r.td,{children:["Whether or not the tool is shown.  TRUE or FALSE",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"true, false"})]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"position",children:"POSITION"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.0.8)"}),(0,n.jsx)(r.strong,{children:"Position of the tool in the nav bar"})]}),"\n",(0,n.jsx)(r.p,{children:"Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Position"}),(0,n.jsx)(r.td,{children:"Numerical position"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-2",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire tool or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"widget",children:"WIDGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a custom widget"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a custom widget that can be used in Telemetry Viewer screens."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Widget Name"}),(0,n.jsxs)(r.td,{children:["The name of the widget wil be used to build a path to the widget implementation. For example, ",(0,n.jsx)(r.code,{children:"WIDGET HELLOWORLD"})," will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide for more details."]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"WIDGET HELLOWORLD\n"})}),"\n",(0,n.jsx)(r.h2,{id:"widget-modifiers",children:"WIDGET Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a WIDGET keyword."}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-3",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire widget or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]})]})}function a(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},5392:(e,r,i)=>{i.d(r,{Z:()=>d,a:()=>l});var n=i(2784);const s={},t=n.createContext(s);function l(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]);

data/tools/staticdocs/assets/js/6b210247.0db8db18.js

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

data/tools/staticdocs/assets/js/6b65133b.3b600a13.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6744],{4011:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=t(2322),s=t(5392);const o={title:"Telemetry Viewer"},r=void 0,c={id:"tools/tlm-viewer",title:"Telemetry Viewer",description:"Introduction",source:"@site/docs/tools/tlm-viewer.md",sourceDirName:"tools",slug:"/tools/tlm-viewer",permalink:"/tools/staticdocs/docs/tools/tlm-viewer",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/tlm-viewer.md",tags:[],version:"current",frontMatter:{title:"Telemetry Viewer"},sidebar:"defaultSidebar",previous:{title:"Telemetry Grapher",permalink:"/tools/staticdocs/docs/tools/tlm-grapher"},next:{title:"Guides",permalink:"/tools/staticdocs/docs/guides"}},a={},l=[{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){const n={a:"a",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.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 build-in widgets."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Telemetry Viewer",src:t(4048).Z+"",width:"1274",height:"895"})}),"\n",(0,i.jsx)(n.h3,{id:"file-menu-items",children:"File Menu Items"}),"\n",(0,i.jsx)("img",{src:t(7848).Z,alt:"File Menu",style:{float:"left","margin-right":"50px",height:"90px"}}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Open a saved configuration"}),"\n",(0,i.jsx)(n.li,{children:"Save the current configuration"}),"\n",(0,i.jsx)(n.li,{children:"Reset the configuration (default settings)"}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"open-configuration",children:"Open Configuration"}),"\n",(0,i.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,i.jsx)(n.h4,{id:"save-configuration",children:"Save Configuration"}),"\n",(0,i.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,i.jsx)(n.h2,{id:"selecting-screens",children:"Selecting Screens"}),"\n",(0,i.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,i.jsx)(n.h2,{id:"new-screen",children:"New Screen"}),"\n",(0,i.jsx)(n.p,{children:"Clicking New Screen brings up the new screen dialog."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Telemetry Viewer",src:t(5824).Z+"",width:"595",height:"424"})}),"\n",(0,i.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,i.jsx)(n.h2,{id:"edit-screen",children:"Edit Screen"}),"\n",(0,i.jsx)(n.p,{children:"Clicking the pencil icon in the title bar of the screen brings up the edit dialog."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Telemetry Viewer",src:t(6078).Z+"",width:"1149",height:"698"})}),"\n",(0,i.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,i.jsx)(n.h2,{id:"screen-window-management",children:"Screen Window Management"}),"\n",(0,i.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,i.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,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Float Minimized",src:t(5690).Z+"",width:"1275",height:"928"})}),"\n",(0,i.jsx)(n.p,{children:"The X button closes the screen."}),"\n",(0,i.jsx)(n.h2,{id:"building-screens",children:"Building Screens"}),"\n",(0,i.jsxs)(n.p,{children:["For documentation on how to build Telemetry Screens and how to configure the\nscreen widgets please see the ",(0,i.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens",children:"Telemetry Screens"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},7848:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/file_menu-8a0c6243e35822617229a729a598ace78e401b6c29f66eb5e07035d77d9be1aa.png"},6078:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/edit_screen-c655c75fe90429c0425b61cccf23835b6882975abaa56de21d58c9a4b19a4773.png"},5690:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/float_minimize-a27fc649e517b279db5d2435fbd4f1de81418b9ef5f47fc83a9443bba0b1a7e0.png"},5824:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/new_screen-0d9bea0538e91fa2332346f1ff73b1dda2e418d295dcd7d6a13ba240cf32187e.png"},4048:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/telemetry_viewer-e4ac466930993a640f95aea4b01bb9a415eec77dfbfaa184f767cb59940ba943.png"},5392:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(2784);const s={},o=i.createContext(s);function r(e){const 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)}}}]);