openc3-cosmos-tool-docs 5.12.0 → 5.13.0

data/tools/docs/assets/js/db8fa1d0.85784608.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9960],{920:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=n(7896),a=(n(2784),n(876));const r={sidebar_position:1,title:"Installation"},i=void 0,s={unversionedId:"getting-started/installation",id:"getting-started/installation",title:"Installation",description:"Installing OpenC3 COSMOS",source:"@site/docs/getting-started/installation.md",sourceDirName:"getting-started",slug:"/getting-started/installation",permalink:"/tools/docs/docs/getting-started/installation",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/installation.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,title:"Installation"},sidebar:"defaultSidebar",previous:{title:"Getting Started",permalink:"/tools/docs/docs/getting-started"},next:{title:"Getting Started",permalink:"/tools/docs/docs/getting-started/gettingstarted"}},l={},c=[{value:"Installing OpenC3 COSMOS",id:"installing-openc3-cosmos",level:2},{value:"Installing OpenC3 COSMOS on Host Machines",id:"installing-openc3-cosmos-on-host-machines",level:2},{value:"PREREQUISITES",id:"prerequisites",level:3},{value:"CLONE PROJECT",id:"clone-project",level:3},{value:"CERTIFICATES",id:"certificates",level:3},{value:"RUN",id:"run",level:3},{value:"CONNECT",id:"connect",level:3},{value:"NEXT STEPS",id:"next-steps",level:3},{value:"Feedback",id:"feedback",level:3}],p={toc:c},d="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"installing-openc3-cosmos"},"Installing OpenC3 COSMOS"),(0,a.kt)("p",null,"The following sections describe how to get OpenC3 COSMOS installed on various operating systems. This document should help you setup you host machine to allow you to have a running version of COSMOS in no time."),(0,a.kt)("h2",{id:"installing-openc3-cosmos-on-host-machines"},"Installing OpenC3 COSMOS on Host Machines"),(0,a.kt)("h3",{id:"prerequisites"},"PREREQUISITES"),(0,a.kt)("p",null,"Install ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/get-docker/"},"Docker")," and install ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/compose/install/"},"Docker Compose"),"."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},"Minimum Resources allocated to Docker: 8GB RAM, 1 CPU, 80GB Disk")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},"Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},"Docker on Windows with WSL2:"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},"WSL2 consumes 50% of total memory on Windows or 8GB, whichever is less. However, on Windows builds before 20175 (use ",(0,a.kt)("inlineCode",{parentName:"p"},"winver")," to check) it consumes 80% of your total memory. This can have a negative effect on Windows performance!")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},"On Windows builds < 20175 or for more fine grained control, create C:","\\","Users","\\","\\<username",">","\\",(0,a.kt)("a",{parentName:"p",href:"https://docs.microsoft.com/en-us/windows/wsl/wsl-config"},".wslconfig"),". Suggested contents on a 32GB machine:"),(0,a.kt)("pre",{parentName:"li"},(0,a.kt)("code",{parentName:"pre"},"[wsl2]\nmemory=16GB\nswap=0\n")))))),(0,a.kt)("admonition",{title:"Important: Modify Docker Connection Timeouts",type:"caution"},(0,a.kt)("p",{parentName:"admonition"},'Docker by default will break idle (no data) connections after a period of 5 minutes. This "feature" will eventually cause you problems if you don\'t adjust the Docker settings. This may manifest as idle connections dropping or simplying failing to resume after data should have started flowing again. Find the file at C:',"\\","Users","\\","username","\\","AppData","\\","Roaming","\\","Docker","\\","settings.json on Windows or ~/Library/Group Containers/group.com.docker/settings.json on MacOS. Modify the value ",(0,a.kt)("inlineCode",{parentName:"p"},"vpnKitMaxPortIdleTime")," to change the timeout (recommend setting to 0). ",(0,a.kt)("strong",{parentName:"p"},"Note:")," 0 means no timeout (idle connections not dropped)")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Note:")," As of December 2021 the COSMOS Docker containers are based on the Alpine Docker image."),(0,a.kt)("h3",{id:"clone-project"},"CLONE PROJECT"),(0,a.kt)("p",null,"Since the COSMOS 5.0.9 release we recommend using the project template to get started."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"    git clone https://github.com/OpenC3/cosmos-project.git tutorial\n")),(0,a.kt)("admonition",{title:"Offline Installation",type:"info"},"  ",(0,a.kt)("p",{style:{"margin-bottom":"20px"}},"If you need to install in an offline environment you should first see if you're able to directly use the COSMOS containers. If so you can first save the containers:"),"  ",(0,a.kt)("p",{style:{"margin-bottom":"20px"}},(0,a.kt)("code",null,"./openc3.sh util save")),"  ",(0,a.kt)("p",{style:{"margin-bottom":"20px"}},"By default this will download the 'latest' images and create tar files in the 'tmp' directory which you can transfer to your offline environment. You can pass a release after 'save' to download a specific release (e.g. util save 5.0.9). Transfer the tar files to your offline environment's project 'tmp' dir and  import them with:"),"  ",(0,a.kt)("p",{style:{"margin-bottom":"20px"}},(0,a.kt)("code",null,"./openc3.sh util load"))),(0,a.kt)("h3",{id:"certificates"},"CERTIFICATES"),(0,a.kt)("p",null,"The COSMOS containers are designed to work and be built in the presence of an SSL Decryption device. To support this a cacert.pem file can be placed at the base of the COSMOS 5 project that includes any certificates needed by your organization. ",(0,a.kt)("strong",{parentName:"p"},"Note"),": If you set the path to the ssl file in the ",(0,a.kt)("inlineCode",{parentName:"p"},"SSL_CERT_FILE")," environment variables the openc3 setup script will copy it and place it for the docker container to load."),(0,a.kt)("admonition",{title:"SSL Issues",type:"caution"},(0,a.kt)("p",{parentName:"admonition"},'Increasingly organizations are using some sort of SSL decryptor device which can cause curl and other command line tools like git to have SSL certificate problems. If installation fails with messages that involve "certificate", "SSL", "self-signed", or "secure" this is the problem. IT typically sets up browsers to work correctly but not command line applications. Note that the file extension might not be .pem, it could be .pem, crt, .ca-bundle, .cer, .p7b, .p7s, or potentially something else.'),(0,a.kt)("p",{parentName:"admonition"},"The workaround is to get a proper local certificate file from your IT department that can be used by tools like curl (for example mine is at C:\\Shared\\Ball.pem). Doesn't matter just somewhere with no spaces."),(0,a.kt)("p",{parentName:"admonition"},"Then set the following environment variables to that path (ie. C:\\Shared\\Ball.pem)"),(0,a.kt)("p",{parentName:"admonition"},"SSL_CERT_FILE",(0,a.kt)("br",null),"\nCURL_CA_BUNDLE",(0,a.kt)("br",null),"\nREQUESTS_CA_BUNDLE",(0,a.kt)("br",null)),(0,a.kt)("p",{parentName:"admonition"},"Here are some directions on environment variables in Windows: ",(0,a.kt)("a",{parentName:"p",href:"https://www.computerhope.com/issues/ch000549.htm"},"Windows Environment Variables")),(0,a.kt)("p",{parentName:"admonition"},"You will need to create new ones with the names above and set their value to the full path to the certificate file.")),(0,a.kt)("h3",{id:"run"},"RUN"),(0,a.kt)("p",null,"Run ",(0,a.kt)("inlineCode",{parentName:"p"},"openc3.bat run")," (Windows), or ",(0,a.kt)("inlineCode",{parentName:"p"},"./openc3.sh run")," (linux/Mac)."),(0,a.kt)("p",null,"Note, you can edit the .env file and change OPENC3_TAG to a specific release (e.g. 5.0.9) rather than 'latest'."),(0,a.kt)("p",null,"If you see an error indicating docker daemon is not running ensure Docker and Docker compose is installed and running. If it errors please try to run ",(0,a.kt)("inlineCode",{parentName:"p"},"docker --version")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose --version")," and try to run the start command again. If the error continues please include the version in your issue if you choose to create one."),(0,a.kt)("p",null,"Running ",(0,a.kt)("inlineCode",{parentName:"p"},"docker ps")," can help show the running containers."),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"openc3.*")," takes multiple arguments. Run with no arguments for help. An example run of openc3.sh with no arguments will show a usage guide."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"./openc3.sh\nUsage: ./openc3.sh [cli, cliroot, start, stop, cleanup, run, util]\n*  cli: run a cli command as the default user ('cli help' for more info)\n*  cliroot: run a cli command as the root user ('cli help' for more info)\n*  start: start the docker-compose openc3\n*  stop: stop the running dockers for openc3\n*  cleanup: cleanup network and volumes for openc3\n*  run: run the prebuilt containers for openc3\n*  util: various helper commands\n")),(0,a.kt)("h3",{id:"connect"},"CONNECT"),(0,a.kt)("p",null,"Connect a web browser to http://localhost:2900. Set the password to whatever you want."),(0,a.kt)("h3",{id:"next-steps"},"NEXT STEPS"),(0,a.kt)("p",null,"Continue to ",(0,a.kt)("a",{parentName:"p",href:"/tools/docs/docs/getting-started/gettingstarted"},"Getting Started"),"."),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"feedback"},"Feedback"),(0,a.kt)("admonition",{title:"Find a problem in the documentation?",type:"note"},(0,a.kt)("pre",{parentName:"admonition"},(0,a.kt)("code",{parentName:"pre"},'Please [create an issue](https://github.com/OpenC3/cosmos/issues/new/choose">create an issue) on\nGitHub describing what we can do to make it better.\n'))))}u.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,o,a=function(e,t){if(null==e)return{};var n,o,a={},r=Object.keys(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||r;return n?o.createElement(h,i(i({ref:t},p),{},{components:n})):o.createElement(h,i({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c<r;c++)i[c]=n[c];return o.createElement.apply(null,i)}return o.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/dc5f7beb.120c148d.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[3712],{9570:(e,t,a)=>{a.d(t,{Z:()=>g});var n=a(7896),l=a(2784),r=a(6277),o=a(5138),s=a(9450),c=a(9846),i=a(2896),d=a(8004),m=a(4198);function u(e){return l.createElement("svg",(0,n.Z)({viewBox:"0 0 24 24"},e),l.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}const p={breadcrumbHomeIcon:"breadcrumbHomeIcon_JFrk"};function b(){const e=(0,m.Z)("/");return l.createElement("li",{className:"breadcrumbs__item"},l.createElement(i.Z,{"aria-label":(0,d.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},l.createElement(u,{className:p.breadcrumbHomeIcon})))}const E={breadcrumbsContainer:"breadcrumbsContainer_zCmv"};function h(e){let{children:t,href:a,isLast:n}=e;const r="breadcrumbs__link";return n?l.createElement("span",{className:r,itemProp:"name"},t):a?l.createElement(i.Z,{className:r,href:a,itemProp:"item"},l.createElement("span",{itemProp:"name"},t)):l.createElement("span",{className:r},t)}function v(e){let{children:t,active:a,index:o,addMicrodata:s}=e;return l.createElement("li",(0,n.Z)({},s&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,r.Z)("breadcrumbs__item",{"breadcrumbs__item--active":a})}),t,l.createElement("meta",{itemProp:"position",content:String(o+1)}))}function g(){const e=(0,s.s1)(),t=(0,c.Ns)();return e?l.createElement("nav",{className:(0,r.Z)(o.k.docs.docBreadcrumbs,E.breadcrumbsContainer),"aria-label":(0,d.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},l.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&l.createElement(b,null),e.map(((t,a)=>{const n=a===e.length-1;return l.createElement(v,{key:a,active:n,index:a,addMicrodata:!!t.href},l.createElement(h,{href:t.href,isLast:n},t.label))})))):null}},570:(e,t,a)=>{a.r(t),a.d(t,{default:()=>Q});var n=a(2784),l=a(5982),r=a(1661);const o=n.createContext(null);function s(e){let{children:t,content:a}=e;const l=function(e){return(0,n.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(a);return n.createElement(o.Provider,{value:l},t)}function c(){const e=(0,n.useContext)(o);if(null===e)throw new r.i6("DocProvider");return e}function i(){const{metadata:e,frontMatter:t,assets:a}=c();return n.createElement(l.d,{title:e.title,description:e.description,keywords:t.keywords,image:a.image??t.image})}var d=a(6277),m=a(6086),u=a(9243);function p(){const{metadata:e}=c();return n.createElement(u.Z,{previous:e.previous,next:e.next})}var b=a(6246),E=a(3362),h=a(5138),v=a(8004);function g(e){let{lastUpdatedAt:t,formattedLastUpdatedAt:a}=e;return n.createElement(v.Z,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:n.createElement("b",null,n.createElement("time",{dateTime:new Date(1e3*t).toISOString()},a))}}," on {date}")}function f(e){let{lastUpdatedBy:t}=e;return n.createElement(v.Z,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:n.createElement("b",null,t)}}," by {user}")}function _(e){let{lastUpdatedAt:t,formattedLastUpdatedAt:a,lastUpdatedBy:l}=e;return n.createElement("span",{className:h.k.common.lastUpdated},n.createElement(v.Z,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:t&&a?n.createElement(g,{lastUpdatedAt:t,formattedLastUpdatedAt:a}):"",byUser:l?n.createElement(f,{lastUpdatedBy:l}):""}},"Last updated{atDate}{byUser}"),!1)}var Z=a(7896);const N={iconEdit:"iconEdit_UohW"};function k(e){let{className:t,...a}=e;return n.createElement("svg",(0,Z.Z)({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,d.Z)(N.iconEdit,t),"aria-hidden":"true"},a),n.createElement("g",null,n.createElement("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})))}function C(e){let{editUrl:t}=e;return n.createElement("a",{href:t,target:"_blank",rel:"noreferrer noopener",className:h.k.common.editThisPage},n.createElement(k,null),n.createElement(v.Z,{id:"theme.common.editThisPage",description:"The link label to edit the current page"},"Edit this page"))}var L=a(2896);const T={tag:"tag_qE9H",tagRegular:"tagRegular_aHXt",tagWithCount:"tagWithCount_UC8q"};function U(e){let{permalink:t,label:a,count:l}=e;return n.createElement(L.Z,{href:t,className:(0,d.Z)(T.tag,l?T.tagWithCount:T.tagRegular)},a,l&&n.createElement("span",null,l))}const w={tags:"tags_q74f",tag:"tag_lSC7"};function x(e){let{tags:t}=e;return n.createElement(n.Fragment,null,n.createElement("b",null,n.createElement(v.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list"},"Tags:")),n.createElement("ul",{className:(0,d.Z)(w.tags,"padding--none","margin-left--sm")},t.map((e=>{let{label:t,permalink:a}=e;return n.createElement("li",{key:a,className:w.tag},n.createElement(U,{label:t,permalink:a}))}))))}const y={lastUpdated:"lastUpdated_T23F"};function A(e){return n.createElement("div",{className:(0,d.Z)(h.k.docs.docFooterTagsRow,"row margin-bottom--sm")},n.createElement("div",{className:"col"},n.createElement(x,e)))}function B(e){let{editUrl:t,lastUpdatedAt:a,lastUpdatedBy:l,formattedLastUpdatedAt:r}=e;return n.createElement("div",{className:(0,d.Z)(h.k.docs.docFooterEditMetaRow,"row")},n.createElement("div",{className:"col"},t&&n.createElement(C,{editUrl:t})),n.createElement("div",{className:(0,d.Z)("col",y.lastUpdated)},(a||l)&&n.createElement(_,{lastUpdatedAt:a,formattedLastUpdatedAt:r,lastUpdatedBy:l})))}function M(){const{metadata:e}=c(),{editUrl:t,lastUpdatedAt:a,formattedLastUpdatedAt:l,lastUpdatedBy:r,tags:o}=e,s=o.length>0,i=!!(t||a||r);return s||i?n.createElement("footer",{className:(0,d.Z)(h.k.docs.docFooter,"docusaurus-mt-lg")},s&&n.createElement(A,{tags:o}),i&&n.createElement(B,{editUrl:t,lastUpdatedAt:a,lastUpdatedBy:r,formattedLastUpdatedAt:l})):null}var I=a(9782),H=a(8954);const P={tocCollapsibleButton:"tocCollapsibleButton_htYj",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_pAh7"};function S(e){let{collapsed:t,...a}=e;return n.createElement("button",(0,Z.Z)({type:"button"},a,{className:(0,d.Z)("clean-btn",P.tocCollapsibleButton,!t&&P.tocCollapsibleButtonExpanded,a.className)}),n.createElement(v.Z,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component"},"On this page"))}const V={tocCollapsible:"tocCollapsible_O_Qc",tocCollapsibleContent:"tocCollapsibleContent_SlnY",tocCollapsibleExpanded:"tocCollapsibleExpanded_klrc"};function D(e){let{toc:t,className:a,minHeadingLevel:l,maxHeadingLevel:r}=e;const{collapsed:o,toggleCollapsed:s}=(0,I.u)({initialState:!0});return n.createElement("div",{className:(0,d.Z)(V.tocCollapsible,!o&&V.tocCollapsibleExpanded,a)},n.createElement(S,{collapsed:o,onClick:s}),n.createElement(I.z,{lazy:!0,className:V.tocCollapsibleContent,collapsed:o},n.createElement(H.Z,{toc:t,minHeadingLevel:l,maxHeadingLevel:r})))}const R={tocMobile:"tocMobile_tjDr"};function F(){const{toc:e,frontMatter:t}=c();return n.createElement(D,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:(0,d.Z)(h.k.docs.docTocMobile,R.tocMobile)})}var z=a(7545);function q(){const{toc:e,frontMatter:t}=c();return n.createElement(z.Z,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:h.k.docs.docTocDesktop})}var O=a(3343),J=a(7133);function W(e){let{children:t}=e;const a=function(){const{metadata:e,frontMatter:t,contentTitle:a}=c();return t.hide_title||void 0!==a?null:e.title}();return n.createElement("div",{className:(0,d.Z)(h.k.docs.docMarkdown,"markdown")},a&&n.createElement("header",null,n.createElement(O.Z,{as:"h1"},a)),n.createElement(J.Z,null,t))}var Y=a(9570);const j={docItemContainer:"docItemContainer_Rv5Z",docItemCol:"docItemCol_YAwJ"};function G(e){let{children:t}=e;const a=function(){const{frontMatter:e,toc:t}=c(),a=(0,m.i)(),l=e.hide_table_of_contents,r=!l&&t.length>0;return{hidden:l,mobile:r?n.createElement(F,null):void 0,desktop:!r||"desktop"!==a&&"ssr"!==a?void 0:n.createElement(q,null)}}();return n.createElement("div",{className:"row"},n.createElement("div",{className:(0,d.Z)("col",!a.hidden&&j.docItemCol)},n.createElement(b.Z,null),n.createElement("div",{className:j.docItemContainer},n.createElement("article",null,n.createElement(Y.Z,null),n.createElement(E.Z,null),a.mobile,n.createElement(W,null,t),n.createElement(M,null)),n.createElement(p,null))),a.desktop&&n.createElement("div",{className:"col col--3"},a.desktop))}function Q(e){const t=`docs-doc-id-${e.content.metadata.unversionedId}`,a=e.content;return n.createElement(s,{content:e.content},n.createElement(l.FG,{className:t},n.createElement(i,null),n.createElement(G,null,n.createElement(a,null))))}},9243:(e,t,a)=>{a.d(t,{Z:()=>i});var n=a(7896),l=a(2784),r=a(8004),o=a(6277),s=a(2896);function c(e){const{permalink:t,title:a,subLabel:n,isNext:r}=e;return l.createElement(s.Z,{className:(0,o.Z)("pagination-nav__link",r?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t},n&&l.createElement("div",{className:"pagination-nav__sublabel"},n),l.createElement("div",{className:"pagination-nav__label"},a))}function i(e){const{previous:t,next:a}=e;return l.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,r.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"})},t&&l.createElement(c,(0,n.Z)({},t,{subLabel:l.createElement(r.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")})),a&&l.createElement(c,(0,n.Z)({},a,{subLabel:l.createElement(r.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next"),isNext:!0})))}},3362:(e,t,a)=>{a.d(t,{Z:()=>c});var n=a(2784),l=a(6277),r=a(8004),o=a(5138),s=a(2993);function c(e){let{className:t}=e;const a=(0,s.E)();return a.badge?n.createElement("span",{className:(0,l.Z)(t,o.k.docs.docVersionBadge,"badge badge--secondary")},n.createElement(r.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:a.label}},"Version: {versionLabel}")):null}},6246:(e,t,a)=>{a.d(t,{Z:()=>h});var n=a(2784),l=a(6277),r=a(5837),o=a(2896),s=a(8004),c=a(7409),i=a(5138),d=a(3855),m=a(2993);const u={unreleased:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(s.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(s.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function p(e){const t=u[e.versionMetadata.banner];return n.createElement(t,e)}function b(e){let{versionLabel:t,to:a,onClick:l}=e;return n.createElement(s.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:n.createElement("b",null,n.createElement(o.Z,{to:a,onClick:l},n.createElement(s.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function E(e){let{className:t,versionMetadata:a}=e;const{siteConfig:{title:o}}=(0,r.Z)(),{pluginId:s}=(0,c.gA)({failfast:!0}),{savePreferredVersionName:m}=(0,d.J)(s),{latestDocSuggestion:u,latestVersionSuggestion:E}=(0,c.Jo)(s),h=u??(v=E).docs.find((e=>e.id===v.mainDocId));var v;return n.createElement("div",{className:(0,l.Z)(t,i.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},n.createElement("div",null,n.createElement(p,{siteTitle:o,versionMetadata:a})),n.createElement("div",{className:"margin-top--md"},n.createElement(b,{versionLabel:E.label,to:h.path,onClick:()=>m(E.name)})))}function h(e){let{className:t}=e;const a=(0,m.E)();return a.banner?n.createElement(E,{className:t,versionMetadata:a}):null}}}]);

data/tools/docs/assets/js/e501b0d1.ae564e73.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1358],{4701:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var i=n(7896),o=(n(2784),n(876));const a={title:"Local Mode"},r=void 0,l={unversionedId:"guides/local-mode",id:"guides/local-mode",title:"Local Mode",description:"Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions.",source:"@site/docs/guides/local-mode.md",sourceDirName:"guides",slug:"/guides/local-mode",permalink:"/tools/docs/docs/guides/local-mode",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/local-mode.md",tags:[],version:"current",frontMatter:{title:"Local Mode"},sidebar:"defaultSidebar",previous:{title:"Little Endian Bitfields",permalink:"/tools/docs/docs/guides/little-endian-bitfields"},next:{title:"Logging",permalink:"/tools/docs/docs/guides/logging"}},s={},c=[{value:"Using Local Mode",id:"using-local-mode",level:2},{value:"Editing scripts",id:"editing-scripts",level:3},{value:"Disabling Local Mode",id:"disabling-local-mode",level:3},{value:"Configuration Management",id:"configuration-management",level:2}],d={toc:c},p="wrapper";function u(e){let{components:t,...a}=e;return(0,o.kt)(p,(0,i.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions."),(0,o.kt)("h2",{id:"using-local-mode"},"Using Local Mode"),(0,o.kt)("p",null,"In this tutorial we will use the COSMOS Demo as configured by the ",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/getting-started/installation"},"Installation Guide"),". You should have cloned a ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/OpenC3/cosmos-project"},"cosmos-project")," and started it using ",(0,o.kt)("inlineCode",{parentName:"p"},"openc3.sh run"),"."),(0,o.kt)("p",null,"If you check the project directory you should see a ",(0,o.kt)("inlineCode",{parentName:"p"},"plugins/DEFAULT/openc3-cosmos-demo")," directory. This will contain both the gem that was installed and a ",(0,o.kt)("inlineCode",{parentName:"p"},"plugin_instance.json")," file. The ",(0,o.kt)("inlineCode",{parentName:"p"},"plugin_instance.json")," file captures the plugin.txt values when the plugin was installed. Note, all files in the plugins directory are meant to be configuration managed with the project. This ensures if you make local edits and check them in, another user can clone the project and get the exact same configuration. We will demonstrate this later."),(0,o.kt)("h3",{id:"editing-scripts"},"Editing scripts"),(0,o.kt)("admonition",{title:"Visual Studio Code",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"This tutorial will use ",(0,o.kt)("a",{parentName:"p",href:"https://code.visualstudio.com"},"VS Code")," which is the editor used by the COSMOS developers.")),(0,o.kt)("p",null,"The most common use case for Local Mode is script development. Launch Script Runner and open the ",(0,o.kt)("inlineCode",{parentName:"p"},"INST/procedures/checks.rb")," file. If you run this script you'll notice that it has a few errors (by design) which prevent it from running to completion. Let's fix it! Comment out the second and fourth lines and save the script. You should now notice that Local Mode has saved a copy of the script to ",(0,o.kt)("inlineCode",{parentName:"p"},"plugins/targets_modified/INST/procedures/checks.rb"),"."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(4678).Z,width:"926",height:"325"})),(0,o.kt)("p",null,"At this point Local Mode keeps these scripts in sync so we can edit in either place. Let's edit the local script by adding a simple comment at the top: ",(0,o.kt)("inlineCode",{parentName:"p"},"# This is a script"),". Now if we go back to Script Runner the changes have not ",(0,o.kt)("em",{parentName:"p"},"automatically")," appeared. However, there is a Reload button next to the filename that will refresh the file from the backend."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(5772).Z,width:"845",height:"360"})),(0,o.kt)("p",null,"Clicking this reloads the file which has been synced into COSMOS and now we see our comment."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(2300).Z,width:"536",height:"102"})),(0,o.kt)("p",null,"It's important not to delete this local file while in Local Mode or COSMOS will display a server error 500. If this happens you can open the Minio Console at http://localhost:2900/minio/ and browse to the file in question to download and restore it."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(2231).Z,width:"1312",height:"442"})),(0,o.kt)("h3",{id:"disabling-local-mode"},"Disabling Local Mode"),(0,o.kt)("p",null,"If you want to disable Local Mode you can edit the .env file and delete the setting ",(0,o.kt)("inlineCode",{parentName:"p"},"OPENC3_LOCAL_MODE=1"),"."),(0,o.kt)("h2",{id:"configuration-management"},"Configuration Management"),(0,o.kt)("p",null,"It is recommended to configuration manage the entire project including the plugins directory. This will allow any user who starts COSMOS to launch an identical configuration. Plugins are created and updated with any modifications found in the targets_modified directory."),(0,o.kt)("p",null,"At some point you will probably want to release your local changes back to the plugin they originated from. Simply copy the entire targets_modified/TARGET directory back to the original plugin. At that point you can rebuild the plugin using the CLI."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"openc3-cosmos-demo % ./openc3.sh cli rake build VERSION=1.0.1\n  Successfully built RubyGem\n  Name: openc3-cosmos-demo\n  Version: 1.0.1\n  File: openc3-cosmos-demo-1.0.1.gem\n")),(0,o.kt)("p",null,"Upgrade the plugin using the Admin Plugins tab and the Upgrade link. When you select your newly built plugin, COSMOS detects the existing changes and asks if you want to delete them. There is a stern warning attached because this will permanently remove these changes! Since we just moved over the changes and rebuilt the plugin we will check the box and INSTALL."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(5363).Z,width:"1057",height:"583"})),(0,o.kt)("p",null,"When the new plugin is installed, the project's ",(0,o.kt)("inlineCode",{parentName:"p"},"plugins")," directory gets updated with the new plugin and everything under the targets_modified directory is removed because there are no modifications on a new install."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Project Layout",src:n(8144).Z,width:"353",height:"305"})),(0,o.kt)("p",null,"Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS."))}u.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var i=n(2784);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,i,o=function(e,t){if(null==e)return{};var n,i,o={},a=Object.keys(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i<a.length;i++)n=a[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=i.createContext({}),c=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=c(e.components);return i.createElement(s.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},h=i.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),h=o,m=p["".concat(s,".").concat(h)]||p[h]||u[h]||a;return n?i.createElement(m,r(r({ref:t},d),{},{components:n})):i.createElement(m,r({ref:t},d))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,r=new Array(a);r[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:o,r[1]=l;for(var c=2;c<a;c++)r[c]=n[c];return i.createElement.apply(null,r)}return i.createElement.apply(null,n)}h.displayName="MDXCreateElement"},5363:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/delete_modified-a7ec0ceb61c37398d57fcecf11ebe2453ebd0110be6cfc960a5073a13a557638.png"},2231:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/minio-150460ac77a50711835de6f0150d019000e5515afae0f3adfcdda8e891484f47.png"},4678:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/project-fe7ac90f3e45971fca8f1be94be9dbabe494bafe705e7f8f485676e9d96e47ea.png"},8144:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/project_update-8e7de3b0658b95d4d9931eb52ff8bf339d633cbdc273ce096eb11ceb357c009e.png"},5772:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/reload_file-8e26cd3e1bc1eab7bb6c046d9a6a8231fcd76e56682d819b1e549182890c6486.png"},2300:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/reloaded-9effa15527244928ee503eb0c3a48cc5e82c07cfb5d5c4300eacfcab913069d1.png"}}]);

data/tools/docs/assets/js/f15615f1.3126a842.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4533],{655:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var n=a(7896),l=(a(2784),a(876));const r={sidebar_position:5,title:"Telemetry"},i=void 0,s={unversionedId:"configuration/telemetry",id:"configuration/telemetry",title:"Telemetry",description:"Telemetry Definition Files",source:"@site/docs/configuration/telemetry.md",sourceDirName:"configuration",slug:"/configuration/telemetry",permalink:"/tools/docs/docs/configuration/telemetry",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5,title:"Telemetry"},sidebar:"defaultSidebar",previous:{title:"Commands",permalink:"/tools/docs/docs/configuration/command"},next:{title:"Interfaces",permalink:"/tools/docs/docs/configuration/interfaces"}},o={},m=[{value:"Telemetry Definition Files",id:"telemetry-definition-files",level:2},{value:"ID Items",id:"id-items",level:3},{value:"Variable Sized Items",id:"variable-sized-items",level:3},{value:"Derived Items",id:"derived-items",level:3},{value:"Received Time and Packet Time",id:"received-time-and-packet-time",level:3},{value:"Example",id:"example",level:4},{value:"TELEMETRY",id:"telemetry",level:2},{value:"TELEMETRY Modifiers",id:"telemetry-modifiers",level:2},{value:"ITEM",id:"item",level:3},{value:"ITEM Modifiers",id:"item-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:"STATE",id:"state",level:4},{value:"READ_CONVERSION",id:"read_conversion",level:4},{value:"POLY_READ_CONVERSION",id:"poly_read_conversion",level:4},{value:"SEG_POLY_READ_CONVERSION",id:"seg_poly_read_conversion",level:4},{value:"GENERIC_READ_CONVERSION_START",id:"generic_read_conversion_start",level:4},{value:"GENERIC_READ_CONVERSION_END",id:"generic_read_conversion_end",level:4},{value:"LIMITS",id:"limits",level:4},{value:"LIMITS_RESPONSE",id:"limits_response",level:4},{value:"APPEND_ITEM",id:"append_item",level:3},{value:"ID_ITEM",id:"id_item",level:3},{value:"APPEND_ID_ITEM",id:"append_id_item",level:3},{value:"ARRAY_ITEM",id:"array_item",level:3},{value:"APPEND_ARRAY_ITEM",id:"append_array_item",level:3},{value:"SELECT_ITEM",id:"select_item",level:3},{value:"DELETE_ITEM",id:"delete_item",level:3},{value:"META",id:"meta-1",level:3},{value:"PROCESSOR",id:"processor",level:3},{value:"ALLOW_SHORT",id:"allow_short",level:3},{value:"HIDDEN",id:"hidden",level:3},{value:"ACCESSOR",id:"accessor",level:3},{value:"SELECT_TELEMETRY",id:"select_telemetry",level:2},{value:"LIMITS_GROUP",id:"limits_group",level:2},{value:"LIMITS_GROUP_ITEM",id:"limits_group_item",level:2},{value:"Example File",id:"example-file",level:2}],d={toc:m},p="wrapper";function u(e){let{components:t,...a}=e;return(0,l.kt)(p,(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h2",{id:"telemetry-definition-files"},"Telemetry Definition Files"),(0,l.kt)("p",null,"Telemetry definition files define the telemetry packets that can be received and processed from COSMOS targets. One large file can be used to define the telemetry packets, or multiple files can be used at the user's discretion. Telemetry definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some telemetry files that depend on others, e.g. they override or extend existing telemetry, they must be named last. The easist way to do this is to add an extension to an existing file name. For example, if you already have tlm.txt you can create tlm_override.txt for telemetry that depends on the definitions in tlm.txt. Note that due to the way the ",(0,l.kt)("a",{parentName:"p",href:"http://www.asciitable.com/"},"ASCII Table")," is structured, files beginning with capital letters are processed before lower case letters."),(0,l.kt)("p",null,"When defining telemetry items you can choose from the following data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data. Within COSMOS, the only difference between a STRING and BLOCK is when COSMOS reads a STRING type it stops reading when it encounters a null byte (0). This shows up when displaying the value in Packet Viewer or Tlm Viewer and in the output of Data Extractor. You should strive to store non-ASCII data inside BLOCK items and ASCII strings in STRING items."),(0,l.kt)("admonition",{title:"Printing Data",type:"info"},(0,l.kt)("p",{parentName:"admonition"},"Most data types can be printed in a COSMOS script simply by doing ",(0,l.kt)("code",null,'puts tlm("TGT PKT ITEM")'),". However, if the ITEM is a BLOCK data type and contains binary (non-ASCII) data then that won't work. COSMOS comes with a built-in method called ",(0,l.kt)("code",null,"formatted")," to help you view binary data. If ITEM is a BLOCK type containing binary try ",(0,l.kt)("code",null,'puts tlm("TGT PKT ITEM").formatted')," which will print the bytes out as hex.")),(0,l.kt)("h3",{id:"id-items"},"ID Items"),(0,l.kt)("p",null,"All packets require identification items so the incoming data can be matched to a packet structure. These items are defined using the ",(0,l.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry#id_item"},"ID_ITEM")," and ",(0,l.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry#append_id_item"},"APPEND_ID_ITEM"),". As data is read from the interface and refined by the protocol, the resulting packet is identified by matching all the ID fields. Note that ideally all packets in a particular target should use the exact same bit offset, bit size, and data type to identify. If this is not the case, you must set ",(0,l.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/target#tlm_unique_id_mode"},"TLM_UNIQUE_ID_MODE")," in the target.txt file which incurs a performance penalty on every packet identification."),(0,l.kt)("h3",{id:"variable-sized-items"},"Variable Sized Items"),(0,l.kt)("p",null,"COSMOS specifies a variable sized item with a bit size of 0. When a packet is identified, all other data that isn't explicitly defined will be put into the variable sized item. These items are typically used for packets containing memory dumps which vary in size depending on the number of bytes dumped. Note that there can only be one variable sized item per packet."),(0,l.kt)("h3",{id:"derived-items"},"Derived Items"),(0,l.kt)("p",null,"COSMOS has a concept of a derived item which is a telemetry item that doesn't actually exist in the binary data. Derived items are typically computed based on other telemetry items. COSMOS derived items are very similar to real items except they use the special DERIVED data type. Here is how a derived item might look in a telemetry definition."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'ITEM TEMP_AVERAGE 0 0 DERIVED "Average of TEMP1, TEMP2, TEMP3, TEMP4"\n')),(0,l.kt)("p",null,"Note the bit offset and bit size of 0 and the data type of DERIVED. For this reason DERIVED items should be declared using ITEM rather than APPEND_ITEM. They can be defined anywhere in the packet definition but are typically placed at the end. The ITEM definition must be followed by a CONVERSION keyword, e.g. ",(0,l.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry#read_conversion"},"READ_CONVERSION"),", to generate the value."),(0,l.kt)("h3",{id:"received-time-and-packet-time"},"Received Time and Packet Time"),(0,l.kt)("p",null,"COSMOS automatically creates several telemetry items on every packet: PACKET_TIMESECONDS, PACKET_TIMEFORMATTED, RECEIVED_COUNT, RECEIVED_TIMEFORMATTED, and RECEIVED_TIMESECONDS."),(0,l.kt)("p",null,"RECEIVED_TIME is the time that COSMOS receives the packet. This is set by the interface which is connected to the target and is receiving the raw data. Once a packet has been created out of the raw data the time is set."),(0,l.kt)("p",null,"PACKET_TIME defaults to RECEIVED_TIME, but can be set as a derived item with a time object in the telemetry configuration file. This helps support stored telemetry packets so that they can be more reasonably handled by other COSMOS tools such as Telemetry Grapher and Data Extractor. You can set the 'stored' flag in your interface and the current value table is unaffected."),(0,l.kt)("p",null,"The ","_","TIMEFORMATTED items returns the date and time in a YYYY/MM/DD HH:MM:SS.sss format and the ","_","TIMESECONDS returns the Unix seconds of the time."),(0,l.kt)("h4",{id:"example"},"Example"),(0,l.kt)("p",null,"COSMOS provides a Unix time conversion class which returns a Ruby time object based on the number of seconds and (optionally) microseconds since the Unix epoch. Note: This returns a Ruby Time object and not a float or string!"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},'ITEM PACKET_TIME 0 0 DERIVED "Ruby time based on TIMESEC and TIMEUS"\n    READ_CONVERSION unix_time_conversion.rb TIMESEC TIMEUS\n')),(0,l.kt)("p",null,"Definining PACKET_TIME allows the PACKET_TIMESECONDS and PACKET_TIMEFORMATTED to be calculated against an internal Packet time rather than the time COSMOS receives the packet."),(0,l.kt)("div",{style:{clear:"both"}}),(0,l.kt)("h1",{id:"telemetry-keywords"},"Telemetry Keywords"),(0,l.kt)("h2",{id:"telemetry"},"TELEMETRY"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a new telemetry packet")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Target"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the target this telemetry packet is associated with"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Command"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of this telemetry packet. Also referred to as its mnemonic. Must be unique to telemetry packets in this target. Ideally will be as short and clear as possible."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the data in this packet is in Big Endian or Little Endian format",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description of this telemetry packet which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Instrument health and status"\n')),(0,l.kt)("h2",{id:"telemetry-modifiers"},"TELEMETRY Modifiers"),(0,l.kt)("p",null,"The following keywords must follow a TELEMETRY keyword."),(0,l.kt)("h3",{id:"item"},"ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a telemetry item in the current telemetry packet")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of this telemetry item. 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,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of this telemetry item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description for this telemetry item which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on ",(0,l.kt)("a",{parentName:"td",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'ITEM PKTID 112 16 UINT "Packet ID"\nITEM DATA 0 0 DERIVED "Derived data"\n')),(0,l.kt)("h3",{id:"item-modifiers"},"ITEM Modifiers"),(0,l.kt)("p",null,"The following keywords must follow a ITEM keyword."),(0,l.kt)("h4",{id:"format_string"},"FORMAT_STRING"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Adds printf style formatting")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Format"),(0,l.kt)("td",{parentName:"tr",align:null},"How to format using printf syntax. For example, '0x%0X' will display the value in hex."),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'FORMAT_STRING "0x%0X"\n')),(0,l.kt)("h4",{id:"units"},"UNITS"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Add displayed units")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Full Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Full name of the units type, e.g. Celsius"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Abbreviated"),(0,l.kt)("td",{parentName:"tr",align:null},"Abbreviation for the units, e.g. C"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"UNITS Celsius C\nUNITS Kilometers KM\n")),(0,l.kt)("h4",{id:"description"},"DESCRIPTION"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Override the defined description")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Value"),(0,l.kt)("td",{parentName:"tr",align:null},"The new description"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("h4",{id:"meta"},"META"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Stores custom user metadata")),(0,l.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,l.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'META TEST "This parameter is for test purposes only"\n')),(0,l.kt)("h4",{id:"overlap"},"OVERLAP"),(0,l.kt)("div",{class:"right"},"(Since 4.4.1)"),"**This item is allowed to overlap other items in the packet**",(0,l.kt)("p",null,"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message."),(0,l.kt)("h4",{id:"key"},"KEY"),(0,l.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the key used to access this raw value in the packet.**",(0,l.kt)("p",null,"Keys are often JsonPath or XPath strings"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Key string"),(0,l.kt)("td",{parentName:"tr",align:null},"The key to access this item"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"KEY $.book.title\n")),(0,l.kt)("h4",{id:"state"},"STATE"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a key/value pair for the current item")),(0,l.kt)("p",null,"Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the telemetry item and allows for much greater clarity and less chance for user error. A catch all value of ANY applies to all other values not already defined as state values."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Key"),(0,l.kt)("td",{parentName:"tr",align:null},"The string state name"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Value"),(0,l.kt)("td",{parentName:"tr",align:null},"The numerical state value or ANY to apply the state to all other values"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Color"),(0,l.kt)("td",{parentName:"tr",align:null},"The color the state should be displayed as",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"GREEN, YELLOW, RED")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ITEM ENABLE 32 UINT "Enable setting"\n  STATE FALSE 0\n  STATE TRUE 1\n  STATE ERROR ANY # Match all other values to ERROR\nAPPEND_ITEM STRING 1024 STRING "String"\n  STATE "NOOP" "NOOP" GREEN\n  STATE "ARM LASER" "ARM LASER" YELLOW\n  STATE "FIRE LASER" "FIRE LASER" RED\n')),(0,l.kt)("h4",{id:"read_conversion"},"READ_CONVERSION"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Applies a conversion to the current telemetry item")),(0,l.kt)("p",null,"Conversions are implemented in a custom Ruby file which should be located in the target's lib folder and required by the target's target.txt file (see REQUIRE). The class must require 'openc3/conversions/conversion' and inherit from Conversion. It must implement the initialize method if it takes extra parameters and must always implement the call method. The conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Class Filename"),(0,l.kt)("td",{parentName:"tr",align:null},"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("td",{parentName:"tr",align:null},"Additional parameter values for the conversion which are passed to the class constructor."),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"READ_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * @multiplier\n    end\n  end\nend\n")),(0,l.kt)("h4",{id:"poly_read_conversion"},"POLY_READ_CONVERSION"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Adds a polynomial conversion factor to the current telemetry item")),(0,l.kt)("p",null,"The conversion factor is applied to raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"C0"),(0,l.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Cx"),(0,l.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"POLY_READ_CONVERSION 10 0.5 0.25\n")),(0,l.kt)("h4",{id:"seg_poly_read_conversion"},"SEG_POLY_READ_CONVERSION"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Adds a segmented polynomial conversion factor to the current telemetry item")),(0,l.kt)("p",null,"This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Lower Bound"),(0,l.kt)("td",{parentName:"tr",align:null},"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"C0"),(0,l.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Cx"),(0,l.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"SEG_POLY_READ_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_READ_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_READ_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n")),(0,l.kt)("h4",{id:"generic_read_conversion_start"},"GENERIC_READ_CONVERSION_START"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Start a generic read conversion")),(0,l.kt)("p",null,"Adds a generic conversion function to the current telemetry item. This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog. The conversion is specified as ruby code that receives two implied parameters. 'value' which is the raw value being read and 'packet' which is a reference to the telemetry packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of ruby code given should return the converted value. The GENERIC_READ_CONVERSION_END keyword specifies that all lines of ruby code for the conversion have been given."),(0,l.kt)("div",{class:"note warning"},(0,l.kt)("p",null,"Generic conversions are not a good long term solution. Consider creating a conversion class and using READ_CONVERSION instead. READ_CONVERSION is easier to debug and higher performance.")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Converted Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Type of the converted value",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK")),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Converted Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of converted value"),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"APPEND_ITEM ITEM1 32 UINT\n  GENERIC_READ_CONVERSION_START\n    value * 1.5  # Convert the value by a scale factor\n  GENERIC_READ_CONVERSION_END\n")),(0,l.kt)("h4",{id:"generic_read_conversion_end"},"GENERIC_READ_CONVERSION_END"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Complete a generic read conversion")),(0,l.kt)("h4",{id:"limits"},"LIMITS"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a set of limits for a telemetry item")),(0,l.kt)("p",null,'If limits are violated a message is printed in the Command and Telemetry Server to indicate an item went out of limits. Other tools also use this information to update displays with different colored telemetry items or other useful information. The concept of "limits sets" is defined to allow for different limits values in different environments. For example, you might want tighter or looser limits on telemetry if your environment changes such as during thermal vacuum testing.'),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Limits Set"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the limits set. If you have no unique limits sets use the keyword DEFAULT."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Persistence"),(0,l.kt)("td",{parentName:"tr",align:null},"Number of consecutive times the telemetry item must be within a different limits range before changing limits state."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Initial State"),(0,l.kt)("td",{parentName:"tr",align:null},"Whether limits monitoring for this telemetry item is initially enabled or disabled. Note if you have multiple LIMITS items they should all have the same initial state.",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"ENABLED, DISABLED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Red Low Limit"),(0,l.kt)("td",{parentName:"tr",align:null},"If the telemetry value is less than or equal to this value a Red Low condition will be detected"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Yellow Low Limit"),(0,l.kt)("td",{parentName:"tr",align:null},"If the telemetry value is less than or equal to this value, but greater than the Red Low Limit, a Yellow Low condition will be detected"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Yellow High Limit"),(0,l.kt)("td",{parentName:"tr",align:null},"If the telemetry value is greater than or equal to this value, but less than the Red High Limit, a Yellow High condition will be detected"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Red High Limit"),(0,l.kt)("td",{parentName:"tr",align:null},"If the telemetry value is greater than or equal to this value a Red High condition will be detected"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Green Low Limit"),(0,l.kt)("td",{parentName:"tr",align:null},'Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is greater than or equal to this value, but less than the Green High Limit, a Blue operational condition will be detected.'),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Green High Limit"),(0,l.kt)("td",{parentName:"tr",align:null},'Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is less than or equal to this value, but greater than the Green Low Limit, a Blue operational condition will be detected.'),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"LIMITS DEFAULT 3 ENABLED -80.0 -70.0 60.0 80.0 -20.0 20.0\nLIMITS TVAC 3 ENABLED -80.0 -30.0 30.0 80.0\n")),(0,l.kt)("h4",{id:"limits_response"},"LIMITS_RESPONSE"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a response class that is called when the limits state of the current item changes")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Response Class Filename"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the Ruby file which implements the limits response. This file should be in the config/TARGET/lib directory so it can be found by OpenC3."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Response Specific Options"),(0,l.kt)("td",{parentName:"tr",align:null},"Variable length number of options that will be passed to the class constructor"),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"LIMITS_RESPONSE example_limits_response.rb 10\n")),(0,l.kt)("h3",{id:"append_item"},"APPEND_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a telemetry item in the current telemetry packet")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of this telemetry item. 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,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of this telemetry item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description for this telemetry item which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on ",(0,l.kt)("a",{parentName:"td",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ITEM PKTID 16 UINT "Packet ID"\n')),(0,l.kt)("h3",{id:"id_item"},"ID_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},'Defines a telemetry item in the current telemetry packet. Note, packets defined without one or more ID_ITEMs are "catch-all" packets which will match all incoming data. Normally this is the job of the UNKNOWN packet.')),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of this telemetry item. 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,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of this telemetry item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"ID Value"),(0,l.kt)("td",{parentName:"tr",align:null},"The value of this telemetry item that uniquely identifies this telemetry packet"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description for this telemetry item which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on ",(0,l.kt)("a",{parentName:"td",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'ID_ITEM PKTID 112 16 UINT 1 "Packet ID which must be 1"\n')),(0,l.kt)("h3",{id:"append_id_item"},"APPEND_ID_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a telemetry item in the current telemetry packet")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of this telemetry item. 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,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of this telemetry item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"ID Value"),(0,l.kt)("td",{parentName:"tr",align:null},"The value of this telemetry item that uniquely identifies this telemetry packet"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description for this telemetry item which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the item is to be interpreted in Big Endian or Little Endian format. See guide on ",(0,l.kt)("a",{parentName:"td",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ID_ITEM PKTID 16 UINT 1 "Packet ID which must be 1"\n')),(0,l.kt)("h3",{id:"array_item"},"ARRAY_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a telemetry item in the current telemetry packet that is an array")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of each array item"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of each array item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Array Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the data is to be sent in Big Endian or Little Endian format",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'ARRAY_ITEM ARRAY 64 32 FLOAT 320 "Array of 10 floats"\n')),(0,l.kt)("h3",{id:"append_array_item"},"APPEND_ARRAY_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a telemetry item in the current telemetry packet that is an array")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemety item. Must be unique within the packet."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Bit size of each array item"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item Data Type"),(0,l.kt)("td",{parentName:"tr",align:null},"Data Type of each array item",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"INT, UINT, FLOAT, STRING, BLOCK, DERIVED")),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Array Bit Size"),(0,l.kt)("td",{parentName:"tr",align:null},"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Description"),(0,l.kt)("td",{parentName:"tr",align:null},"Description which must be enclosed with quotes"),(0,l.kt)("td",{parentName:"tr",align:null},"False")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,l.kt)("td",{parentName:"tr",align:null},"Indicates if the data is to be sent in Big Endian or Little Endian format",(0,l.kt)("br",null),(0,l.kt)("br",null),"Valid Values: ",(0,l.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_ARRAY_ITEM ARRAY 32 FLOAT 320 "Array of 10 floats"\n')),(0,l.kt)("h3",{id:"select_item"},"SELECT_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Selects an existing telemetry item for editing")),(0,l.kt)("p",null,"Must be used in conjunction with SELECT_TELEMETRY to first select the packet. Typically used to override generated values or make specific changes to telemetry that only affect a particular instance of a target used multiple times."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the item to select for modification"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_TELEMETRY INST HEALTH_STATUS\n  SELECT_ITEM TEMP1\n    # Define limits for this item, overrides or replaces any existing\n    LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0\n")),(0,l.kt)("h3",{id:"delete_item"},"DELETE_ITEM"),(0,l.kt)("div",{class:"right"},"(Since 4.4.1)"),"**Delete an existing telemetry item from the packet definition**",(0,l.kt)("p",null,'Deleting an item from the packet definition does not remove the defined space for that item. Thus unless you redefine a new item, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_TELEMETRY and then ITEM to define a new item.'),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the item to delete"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_TELEMETRY INST HEALTH_STATUS\n  DELETE_ITEM TEMP4\n")),(0,l.kt)("h3",{id:"meta-1"},"META"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Stores metadata for the current telemetry packet")),(0,l.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,l.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'META FSW_TYPE "struct tlm_packet"\n')),(0,l.kt)("h3",{id:"processor"},"PROCESSOR"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a processor class that executes code every time a packet is received")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Processor Name"),(0,l.kt)("td",{parentName:"tr",align:null},"The name of the processor"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Processor Class Filename"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the Ruby file which implements the processor. This file should be in the config/TARGET/lib directory so it can be found by OpenC3."),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Processor Specific Options"),(0,l.kt)("td",{parentName:"tr",align:null},"Variable length number of options that will be passed to the class constructor."),(0,l.kt)("td",{parentName:"tr",align:null},"False")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1\n")),(0,l.kt)("h3",{id:"allow_short"},"ALLOW_SHORT"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Process telemetry packets which are less than their defined length")),(0,l.kt)("p",null,"Allows the telemetry packet to be received with a data portion that is smaller than the defined size without warnings. Any extra space in the packet will be filled in with zeros by OpenC3."),(0,l.kt)("h3",{id:"hidden"},"HIDDEN"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Hides this telemetry packet from all the OpenC3 tools")),(0,l.kt)("p",null,"This packet will not appear in Packet Viewer, Telemetry Grapher and Handbook Creator. It also hides this telemetry from appearing in the Script Runner popup helper when writing scripts. The telemetry still exists in the system and can received and checked by scripts."),(0,l.kt)("h3",{id:"accessor"},"ACCESSOR"),(0,l.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the class used to read and write raw values from the packet**",(0,l.kt)("p",null,"Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Accessor Class Name"),(0,l.kt)("td",{parentName:"tr",align:null},"The name of the accessor class"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("h2",{id:"select_telemetry"},"SELECT_TELEMETRY"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Selects an existing telemetry packet for editing")),(0,l.kt)("p",null,"Typically used in a separate configuration file from where the original telemetry is defined to override or add to the existing telemetry definition. Must be used in conjunction with SELECT_ITEM to change an individual item."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the target this telemetry packet is associated with"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Packet Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemetry packet to select"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"SELECT_TELEMETRY INST HEALTH_STATUS\n  SELECT_ITEM TEMP1\n    # Define limits for this item, overrides or replaces any existing\n    LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0\n")),(0,l.kt)("h2",{id:"limits_group"},"LIMITS_GROUP"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Defines a group of related limits Items")),(0,l.kt)("p",null,'Limits groups contain telemetry items that can be enabled and disabled together. It can be used to group related limits as a subsystem that can be enabled or disabled as that particular subsystem is powered (for example). To enable a group call the enable_limits_group("NAME") method in Script Runner. To disable a group call the disable_limits_group("NAME") in Script Runner. Items can belong to multiple groups but the last enabled or disabled group "wins". For example, if an item belongs to GROUP1 and GROUP2 and you first enable GROUP1 and then disable GROUP2 the item will be disabled. If you then enable GROUP1 again it will be enabled.'),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Group Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the limits group"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("h2",{id:"limits_group_item"},"LIMITS_GROUP_ITEM"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Adds the specified telemetry item to the last defined LIMITS_GROUP")),(0,l.kt)("p",null,"Limits group information is typically kept in a separate configuration file in the config/TARGET/cmd_tlm folder named limits_groups.txt."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the target"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Packet Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the packet"),(0,l.kt)("td",{parentName:"tr",align:null},"True")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"Item Name"),(0,l.kt)("td",{parentName:"tr",align:null},"Name of the telemetry item to add to the group"),(0,l.kt)("td",{parentName:"tr",align:null},"True")))),(0,l.kt)("p",null,"Example Usage:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},"LIMITS_GROUP SUBSYSTEM\n  LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1\n  LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2\n  LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3\n")),(0,l.kt)("h2",{id:"example-file"},"Example File"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example File: TARGET/cmd_tlm/tlm.txt")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ruby"},'TELEMETRY TARGET HS BIG_ENDIAN "Health and Status for My Target"\n  ITEM CCSDSVER 0 3 UINT "CCSDS PACKET VERSION NUMBER (SEE CCSDS 133.0-B-1)"\n  ITEM CCSDSTYPE 3 1 UINT "CCSDS PACKET TYPE (COMMAND OR TELEMETRY)"\n    STATE TLM 0\n    STATE CMD 1\n  ITEM CCSDSSHF 4 1 UINT "CCSDS SECONDARY HEADER FLAG"\n    STATE FALSE 0\n    STATE TRUE 1\n  ID_ITEM CCSDSAPID 5 11 UINT 102 "CCSDS APPLICATION PROCESS ID"\n  ITEM CCSDSSEQFLAGS 16 2 UINT "CCSDS SEQUENCE FLAGS"\n    STATE FIRST 0\n    STATE CONT 1\n    STATE LAST 2\n    STATE NOGROUP 3\n  ITEM CCSDSSEQCNT 18 14 UINT "CCSDS PACKET SEQUENCE COUNT"\n  ITEM CCSDSLENGTH 32 16 UINT "CCSDS PACKET DATA LENGTH"\n  ITEM CCSDSDAY 48 16 UINT "DAYS SINCE EPOCH (JANUARY 1ST, 1958, MIDNIGHT)"\n  ITEM CCSDSMSOD 64 32 UINT "MILLISECONDS OF DAY (0 - 86399999)"\n  ITEM CCSDSUSOMS 96 16 UINT "MICROSECONDS OF MILLISECOND (0-999)"\n  ITEM ANGLEDEG 112 16 INT "Instrument Angle in Degrees"\n    POLY_READ_CONVERSION 0 57.295\n  ITEM MODE 128 8 UINT "Instrument Mode"\n    STATE NORMAL 0 GREEN\n    STATE DIAG 1 YELLOW\n  ITEM TIMESECONDS 0 0 DERIVED "DERIVED TIME SINCE EPOCH IN SECONDS"\n    GENERIC_READ_CONVERSION_START FLOAT 32\n      ((packet.read(\'ccsdsday\') * 86400.0) + (packet.read(\'ccsdsmsod\') / 1000.0) + (packet.read(\'ccsdsusoms\') / 1000000.0)  )\n    GENERIC_READ_CONVERSION_END\n  ITEM TIMEFORMATTED 0 0 DERIVED "DERIVED TIME SINCE EPOCH AS A FORMATTED STRING"\n    GENERIC_READ_CONVERSION_START STRING 216\n      time = Time.ccsds2mdy(packet.read(\'ccsdsday\'), packet.read(\'ccsdsmsod\'), packet.read(\'ccsdsusoms\'))\n      sprintf(\'%04u/%02u/%02u %02u:%02u:%02u.%06u\', time[0], time[1], time[2], time[3], time[4], time[5], time[6])\n    GENERIC_READ_CONVERSION_END\n')))}u.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(2784);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?r(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):r(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,n,l=function(e,t){if(null==e)return{};var a,n,l={},r=Object.keys(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var o=n.createContext({}),m=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=m(e.components);return n.createElement(o.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,r=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),p=m(a),k=l,N=p["".concat(o,".").concat(k)]||p[k]||u[k]||r;return a?n.createElement(N,i(i({ref:t},d),{},{components:a})):n.createElement(N,i({ref:t},d))}));function N(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var r=a.length,i=new Array(r);i[0]=k;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[p]="string"==typeof e?e:l,i[1]=s;for(var m=2;m<r;m++)i[m]=a[m];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}k.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/fd886806.d2d0bdf4.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7972],{9570:(e,t,a)=>{a.d(t,{Z:()=>E});var n=a(7896),r=a(2784),i=a(6277),l=a(5138),c=a(9450),s=a(9846),o=a(2896),m=a(8004),d=a(4198);function u(e){return r.createElement("svg",(0,n.Z)({viewBox:"0 0 24 24"},e),r.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}const h={breadcrumbHomeIcon:"breadcrumbHomeIcon_JFrk"};function b(){const e=(0,d.Z)("/");return r.createElement("li",{className:"breadcrumbs__item"},r.createElement(o.Z,{"aria-label":(0,m.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},r.createElement(u,{className:h.breadcrumbHomeIcon})))}const v={breadcrumbsContainer:"breadcrumbsContainer_zCmv"};function p(e){let{children:t,href:a,isLast:n}=e;const i="breadcrumbs__link";return n?r.createElement("span",{className:i,itemProp:"name"},t):a?r.createElement(o.Z,{className:i,href:a,itemProp:"item"},r.createElement("span",{itemProp:"name"},t)):r.createElement("span",{className:i},t)}function g(e){let{children:t,active:a,index:l,addMicrodata:c}=e;return r.createElement("li",(0,n.Z)({},c&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,i.Z)("breadcrumbs__item",{"breadcrumbs__item--active":a})}),t,r.createElement("meta",{itemProp:"position",content:String(l+1)}))}function E(){const e=(0,c.s1)(),t=(0,s.Ns)();return e?r.createElement("nav",{className:(0,i.Z)(l.k.docs.docBreadcrumbs,v.breadcrumbsContainer),"aria-label":(0,m.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},r.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&r.createElement(b,null),e.map(((t,a)=>{const n=a===e.length-1;return r.createElement(g,{key:a,active:n,index:a,addMicrodata:!!t.href},r.createElement(p,{href:t.href,isLast:n},t.label))})))):null}},412:(e,t,a)=>{a.r(t),a.d(t,{default:()=>x});var n=a(2784),r=a(5982),i=a(9450),l=a(4198),c=a(6277),s=a(2896),o=a(8949),m=a(8004);const d={cardContainer:"cardContainer_Shn5",cardTitle:"cardTitle_h48N",cardDescription:"cardDescription_CytT"};function u(e){let{href:t,children:a}=e;return n.createElement(s.Z,{href:t,className:(0,c.Z)("card padding--lg",d.cardContainer)},a)}function h(e){let{href:t,icon:a,title:r,description:i}=e;return n.createElement(u,{href:t},n.createElement("h2",{className:(0,c.Z)("text--truncate",d.cardTitle),title:r},a," ",r),i&&n.createElement("p",{className:(0,c.Z)("text--truncate",d.cardDescription),title:i},i))}function b(e){let{item:t}=e;const a=(0,i.Wl)(t);return a?n.createElement(h,{href:a,icon:"\ud83d\uddc3\ufe0f",title:t.label,description:t.description??(0,m.I)({message:"{count} items",id:"theme.docs.DocCard.categoryDescription",description:"The default description for a category card in the generated index about how many items this category includes"},{count:t.items.length})}):null}function v(e){let{item:t}=e;const a=(0,o.Z)(t.href)?"\ud83d\udcc4\ufe0f":"\ud83d\udd17",r=(0,i.xz)(t.docId??void 0);return n.createElement(h,{href:t.href,icon:a,title:t.label,description:t.description??r?.description})}function p(e){let{item:t}=e;switch(t.type){case"link":return n.createElement(v,{item:t});case"category":return n.createElement(b,{item:t});default:throw new Error(`unknown item type ${JSON.stringify(t)}`)}}function g(e){let{className:t}=e;const a=(0,i.jA)();return n.createElement(E,{items:a.items,className:t})}function E(e){const{items:t,className:a}=e;if(!t)return n.createElement(g,e);const r=(0,i.MN)(t);return n.createElement("section",{className:(0,c.Z)("row",a)},r.map(((e,t)=>n.createElement("article",{key:t,className:"col col--6 margin-bottom--lg"},n.createElement(p,{item:e})))))}var f=a(9243),N=a(6246),Z=a(3362),k=a(9570),_=a(3343);const L={generatedIndexPage:"generatedIndexPage_ak01",list:"list_iQEt",title:"title_AulG"};function T(e){let{categoryGeneratedIndex:t}=e;return n.createElement(r.d,{title:t.title,description:t.description,keywords:t.keywords,image:(0,l.Z)(t.image)})}function y(e){let{categoryGeneratedIndex:t}=e;const a=(0,i.jA)();return n.createElement("div",{className:L.generatedIndexPage},n.createElement(N.Z,null),n.createElement(k.Z,null),n.createElement(Z.Z,null),n.createElement("header",null,n.createElement(_.Z,{as:"h1",className:L.title},t.title),t.description&&n.createElement("p",null,t.description)),n.createElement("article",{className:"margin-top--lg"},n.createElement(E,{items:a.items,className:L.list})),n.createElement("footer",{className:"margin-top--lg"},n.createElement(f.Z,{previous:t.navigation.previous,next:t.navigation.next})))}function x(e){return n.createElement(n.Fragment,null,n.createElement(T,e),n.createElement(y,e))}},9243:(e,t,a)=>{a.d(t,{Z:()=>o});var n=a(7896),r=a(2784),i=a(8004),l=a(6277),c=a(2896);function s(e){const{permalink:t,title:a,subLabel:n,isNext:i}=e;return r.createElement(c.Z,{className:(0,l.Z)("pagination-nav__link",i?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t},n&&r.createElement("div",{className:"pagination-nav__sublabel"},n),r.createElement("div",{className:"pagination-nav__label"},a))}function o(e){const{previous:t,next:a}=e;return r.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,i.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"})},t&&r.createElement(s,(0,n.Z)({},t,{subLabel:r.createElement(i.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")})),a&&r.createElement(s,(0,n.Z)({},a,{subLabel:r.createElement(i.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next"),isNext:!0})))}},3362:(e,t,a)=>{a.d(t,{Z:()=>s});var n=a(2784),r=a(6277),i=a(8004),l=a(5138),c=a(2993);function s(e){let{className:t}=e;const a=(0,c.E)();return a.badge?n.createElement("span",{className:(0,r.Z)(t,l.k.docs.docVersionBadge,"badge badge--secondary")},n.createElement(i.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:a.label}},"Version: {versionLabel}")):null}},6246:(e,t,a)=>{a.d(t,{Z:()=>p});var n=a(2784),r=a(6277),i=a(5837),l=a(2896),c=a(8004),s=a(7409),o=a(5138),m=a(3855),d=a(2993);const u={unreleased:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(c.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){let{siteTitle:t,versionMetadata:a}=e;return n.createElement(c.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function h(e){const t=u[e.versionMetadata.banner];return n.createElement(t,e)}function b(e){let{versionLabel:t,to:a,onClick:r}=e;return n.createElement(c.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:n.createElement("b",null,n.createElement(l.Z,{to:a,onClick:r},n.createElement(c.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function v(e){let{className:t,versionMetadata:a}=e;const{siteConfig:{title:l}}=(0,i.Z)(),{pluginId:c}=(0,s.gA)({failfast:!0}),{savePreferredVersionName:d}=(0,m.J)(c),{latestDocSuggestion:u,latestVersionSuggestion:v}=(0,s.Jo)(c),p=u??(g=v).docs.find((e=>e.id===g.mainDocId));var g;return n.createElement("div",{className:(0,r.Z)(t,o.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},n.createElement("div",null,n.createElement(h,{siteTitle:l,versionMetadata:a})),n.createElement("div",{className:"margin-top--md"},n.createElement(b,{versionLabel:v.label,to:p.path,onClick:()=>d(v.name)})))}function p(e){let{className:t}=e;const a=(0,d.E)();return a.banner?n.createElement(v,{className:t,versionMetadata:a}):null}},3343:(e,t,a)=>{a.d(t,{Z:()=>m});var n=a(7896),r=a(2784),i=a(6277),l=a(8004),c=a(6371),s=a(2896);const o={anchorWithStickyNavbar:"anchorWithStickyNavbar_fF9Z",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_Yh18"};function m(e){let{as:t,id:a,...m}=e;const{navbar:{hideOnScroll:d}}=(0,c.L)();if("h1"===t||!a)return r.createElement(t,(0,n.Z)({},m,{id:void 0}));const u=(0,l.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof m.children?m.children:a});return r.createElement(t,(0,n.Z)({},m,{className:(0,i.Z)("anchor",d?o.anchorWithHideOnScrollNavbar:o.anchorWithStickyNavbar,m.className),id:a}),m.children,r.createElement(s.Z,{className:"hash-link",to:`#${a}`,"aria-label":u,title:u},"\u200b"))}}}]);