openc3-cosmos-tool-docs 5.12.0 → 5.14.0

data/tools/docs/assets/js/43652efd.cbac4bc0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5324],{6777:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>r});var i=a(7896),n=(a(2784),a(876));const o={title:"Data Extractor"},s=void 0,l={unversionedId:"tools/data-extractor",id:"tools/data-extractor",title:"Data Extractor",description:"Introduction",source:"@site/docs/tools/data-extractor.md",sourceDirName:"tools",slug:"/tools/data-extractor",permalink:"/tools/docs/docs/tools/data-extractor",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/data-extractor.md",tags:[],version:"current",frontMatter:{title:"Data Extractor"},sidebar:"defaultSidebar",previous:{title:"Command and Telemetry Server",permalink:"/tools/docs/docs/tools/cmd-tlm-server"},next:{title:"Data Viewer",permalink:"/tools/docs/docs/tools/data-viewer"}},c={},r=[{value:"Introduction",id:"introduction",level:2},{value:"Data Extractor Menus",id:"data-extractor-menus",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Open Configuration",id:"open-configuration",level:4},{value:"Save Configuration",id:"save-configuration",level:4},{value:"Mode Menu Items",id:"mode-menu-items",level:3},{value:"Selecting Items for Output",id:"selecting-items-for-output",level:2},{value:"Start/End Date/Time",id:"startend-datetime",level:3},{value:"Adding Targets Packets Items",id:"adding-targets-packets-items",level:3},{value:"Removing Items",id:"removing-items",level:3},{value:"Editing Items",id:"editing-items",level:3},{value:"Processing Items",id:"processing-items",level:2}],d={toc:r},m="wrapper";function p(e){let{components:t,...o}=e;return(0,n.kt)(m,(0,i.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"introduction"},"Introduction"),(0,n.kt)("p",null,"Data Extractor extracts command and telemetry items into comma or tab separated files. Individual items or entire packets can be processed over any time period. Data Extractor also has a number of options to control the output for post processing in Excel or Matlab, for example."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Data Extractor",src:a(4563).Z,width:"1678",height:"1358"})),(0,n.kt)("h2",{id:"data-extractor-menus"},"Data Extractor Menus"),(0,n.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,n.kt)("img",{src:"/img/v5/data_extractor/file_menu.png",alt:"File Menu",style:{float:"left","margin-right":"50px",height:"160px"}}),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Opens a saved configuration"),(0,n.kt)("li",{parentName:"ul"},"Save the current configuration (item list)"),(0,n.kt)("li",{parentName:"ul"},"Delimit output with commas"),(0,n.kt)("li",{parentName:"ul"},"Delimit output with tabs")),(0,n.kt)("h4",{id:"open-configuration"},"Open Configuration"),(0,n.kt)("p",null,"The Open and Save Configuration options deserve a little more explanation. When you select File Open the Open Configuration dialog appears. It displays a list of all saved configurations (INST_TEMPS in this example). You select a configuration and then click Ok to load it. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Open Config",src:a(2978).Z,width:"1076",height:"500"})),(0,n.kt)("h4",{id:"save-configuration"},"Save Configuration"),(0,n.kt)("p",null,"When you select File Save the Save Configuration dialog appears. It displays a list of all saved configurations (INST_TEMPS in this example). You click the Configuration Name text field, enter the name of your new configuration, and click Ok to save. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Save Config",src:a(2236).Z,width:"1076",height:"592"})),(0,n.kt)("h3",{id:"mode-menu-items"},"Mode Menu Items"),(0,n.kt)("img",{src:"/img/v5/data_extractor/mode_menu.png",alt:"Mode Menu",style:{float:"left","margin-right":"50px",height:"250px"}}),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Fill empty cells with the previous value"),(0,n.kt)("li",{parentName:"ul"},"Add a Matlab comment ('%') to the header"),(0,n.kt)("li",{parentName:"ul"},"Only output changed values"),(0,n.kt)("li",{parentName:"ul"},"Only list item name as column header"),(0,n.kt)("li",{parentName:"ul"},"List full Target Packet Item as header")),(0,n.kt)("h2",{id:"selecting-items-for-output"},"Selecting Items for Output"),(0,n.kt)("h3",{id:"startend-datetime"},"Start/End Date/Time"),(0,n.kt)("p",null,"Data Extractor provides text fields where you specify the time range to extract items. Clicking the Start Date and End Date text fields opens a Date Chooser dialog. Note you can also manually type in the date."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Date Chooser",src:a(2645).Z,width:"820",height:"630"})),(0,n.kt)("p",null,"Clicking the Start Time and End Time icon opens up a Time Chooser dialog. Note you can also manually type in the time."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Time Chooser",src:a(9984).Z,width:"820",height:"602"})),(0,n.kt)("h3",{id:"adding-targets-packets-items"},"Adding Targets Packets Items"),(0,n.kt)("p",null,"Data Extractor provides Target, Packet, Item drop downs to select the items you want to export. When you select a Target the Packet drop down defaults to ","[","All","]",' which sets the button to "Add Target". This would add EVERY item defined in EVERY packet in the target. Note: This can be a LOT of telemetry points but any added point can be removed.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Target",src:a(6389).Z,width:"1652",height:"752"})),(0,n.kt)("p",null,"When you select a Packet the Item drop down defaults to ","[","All","]",' which sets the button to "Add Packet". This would add EVERY item defined in the specified packet. Note: This can be a LOT of telemetry points but any added point can be removed.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Packet",src:a(8935).Z,width:"1652",height:"752"})),(0,n.kt)("p",null,'When you select an individual Item the button changes to "Add Item" and the Description field updates with the item\'s description.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Item",src:a(1896).Z,width:"1652",height:"752"})),(0,n.kt)("h3",{id:"removing-items"},"Removing Items"),(0,n.kt)("p",null,"Once you've added items the Items table will have a list of items."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Items Table",src:a(9612).Z,width:"1652",height:"676"})),(0,n.kt)("p",null,"Items can be removed by clicking the Trash icon next to the item. ALL items can be removed by clicking the Trash icon in the header."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Delete All Mouseover",src:a(7491).Z,width:"288",height:"252"})),(0,n.kt)("h3",{id:"editing-items"},"Editing Items"),(0,n.kt)("p",null,"Items can be edited by clicking the Pencil icon next to the item. ALL items can be edited by clicking the pencil icon in the header."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit All Mouseover",src:a(2428).Z,width:"288",height:"252"})),(0,n.kt)("p",null,"Clicking the Edit All brings up the Edit All Items dialog."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit All",src:a(7973).Z,width:"1060",height:"586"})),(0,n.kt)("p",null,"This allows you to change the data type of all items in the list. In this example we change from the default of CONVERTED to RAW. This updates the item list as follows."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Items Table Raw",src:a(9927).Z,width:"1638",height:"674"})),(0,n.kt)("p",null,"Clicking the pencil next to an individual item brings up a similar dialog."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit TEMP1",src:a(9720).Z,width:"1064",height:"613"})),(0,n.kt)("p",null,"If we change TEMP1 back to CONVERTED the item list is again updated."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit TEMP1",src:a(2566).Z,width:"1638",height:"682"})),(0,n.kt)("h2",{id:"processing-items"},"Processing Items"),(0,n.kt)("p",null,"Clicking the Process button starts the processing of the items list. A progress wheel is shown on the left side of the table and the Process button changes to Cancel to allow cancelling the process."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Processing",src:a(5387).Z,width:"1638",height:"682"})),(0,n.kt)("p",null,"When the processing is complete, the browser shows a file download link. Note this varies by browser. This example is from Chrome."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Download",src:a(8243).Z,width:"257",height:"86"})))}p.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var i=a(2784);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,i)}return a}function s(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?o(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):o(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function l(e,t){if(null==e)return{};var a,i,n=function(e,t){if(null==e)return{};var a,i,n={},o=Object.keys(e);for(i=0;i<o.length;i++)a=o[i],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i<o.length;i++)a=o[i],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var c=i.createContext({}),r=function(e){var t=i.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=r(e.components);return i.createElement(c.Provider,{value:t},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},g=i.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=r(a),g=n,u=m["".concat(c,".").concat(g)]||m[g]||p[g]||o;return a?i.createElement(u,s(s({ref:t},d),{},{components:a})):i.createElement(u,s({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=g;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[m]="string"==typeof e?e:n,s[1]=l;for(var r=2;r<o;r++)s[r]=a[r];return i.createElement.apply(null,s)}return i.createElement.apply(null,a)}g.displayName="MDXCreateElement"},4563:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/data_extractor-62c5b1743ba9dfdff2e393bcbdf863c36effc5ef5319d845cfd17186bd757bca.png"},2645:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/date_chooser-10f7b740b9acc76604e5dc86fe409b6b777abe0fb3fa5ebf8f47cb1ac58b9676.png"},7491:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/delete_all_mouseover-06083f3d3d712d39f21bc5eda45adbfff449732a2061e53cb1a0baf6c5f5d4b8.png"},8243:(e,t,a)=>{a.d(t,{Z:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQEAAABWCAYAAADPECMGAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABPfSURBVHhe7Z0JeE1X18f/N/MkhigxJKZojRVKqSoSFVPQEtUBKTqosYYq7dtSaipKTK0qHUwdlL5FDG0M31udKIJUEFJBEyoyyTycb699z50y57ZJcNbvefZz9tn7nH32Pc76r7X2uXF1zbo9rYBhGM2iA2qzCDCMhrFRtwzDaBQWAYbROCwCDKNxWAQYRuOwCDCMxmERYBiNwyLAMBqHRYBhNI5VXxb66acdWLduHdLS0tSWsuHq6oqXX34ZHTsOUFsYhqksrBKBkSP7Yk9oKHJyctSWwmnYqBFup6QgISEBjm7ucK1WU7TqkPL3NfTr2wdr136rP5BhmErDqnQgXUQAJAC5ublFFhcXF3yxdStWrVol62nJyUi+dROPDBwNj7qN5RgMw1Q+/9qagI2NThZDWJGamorVq1fjiy++QHp6OnJzspCdlor4y38iNemWehTDMJWN1SJgZ6tDDXc7BPpVx9QX6mDOlHqYNbkhxo9sikc71YWzsx22bt2CHTt2ICsrCzqdDVyq1EBqQiJSEm6ooxROixb3Y98+Eo/LUJQ4ISjRYpxPUL9+HdlPW9qndupPSbkorvWhsZ9YtmwO4uMjkZcXi+zsqzh6dB969fKTfRER/yfmdAULF/5H7ptDbdRHxxiYPXsarl8/U+hYxJQpY3Dt2knZn5NzDefOHcHo0c+qvZZ06vQQdu/eLOdMc6fP+PPPuy3GM6d7987yejQujX/16gmMGvWM7KP79NNPuwrtq1LFDZs2rba4R2vXLpZ9BNWL6mO0hVUiUNXVDgO71MD+Vc3xwfSGmBlcB2OfqoUJz1TH7PH1sGnlo/hkzQA82KoW7O31l7B3cEa9hr4I/3Eb8nKLXkughzck5F34+rbCzJnz4O7ug/feWw0/v0fF9m15zPr1y9T91WjSpCOWL/8Iffr4Y82aRbJ/xowJeP75odi+fTe8vdshMHA43Nxc5bj3399EHmNvb4+AgG7yegaoTm3UZ4AEYNq0scLYjqJVq24IDp4ox/rgg0XSoJ9++gl5vd9/PyX7u3QZgBs3buLdd2fIOZnj798Fn3wSAk/P+/Dyy68JYfTEoEEjhVgl4LPPVmDMmGD1SD00n8WLZ6Fq1Sro12+YOH8wEhKS8MYbk9Chgy/+85/JaNasqRChWejcORC3biVi+vTx8jMuWPCmOOdxLFq0Cl5ebbFr1/dyrlOnvoKxY5/H0KEDhZCGyr7//nev3Kd2RntYJQIvBdTG+6MawNvNAc6KDrps0ZgpSi5gqyShql0cerS3w1cbnkCfXi1EVOAEr8YP4fypMORkZ8gximLw4H5o1+5BkUZ8K407JeU23nlnCY4dC8cjj7QX9dfw8MNtheffIdsvXbqMt95aJPepf8iQ/vDxaSS8eTa++26f8I6xIqo4KPudnBzF2K3ldS5fvoqGDb0xfHiQ3CeoTm3UR5ARBgX1x/nzFzFixAT88cd5bNmyHXPnvi/EqQqGDQuS3tjOzg779x+S/b/88js++mgTMjOz0Lat/loGJk16UcznL3z44efCuN+W3nvz5g+Epz8p50he3FyUfH1byv39+w/L/kOHfsKvvx6Xn4Pa27RpiZMnz2DFio/ldenz1qhRDe3btxHiVw8XLkRjzpyl8h6EhobJe0KCQvc3LS1dCM9Xso+2qalpcjxGe1glAtXIu6cryEsTJV0HRdi1kqUDskRnjtjm3IYuMwbuttexbG5XDHhyIGJjTpYoAETjxg2EceRJozfn8ceHoFGjDsJ76kT4mys88zG1R09ExDnY2tqidevm0muTYS5fPld6TUoTyBgaNmwvxYWIibmK5OQU9O37uNwnunZ9RLZRH0Hetlo1dxw/flqKkQGaW4JIa5o185GGeft2qhCiKdKwSRQ2bvxaXmv+/BD1DP1YXl51hdF/I6MUMlAfn07SuHv39sOqVRvE/G3Qv3+Aegbwv//9Kq7xKMaPnyn3yfDpmrGxN2S0QkIUE3NN9hF03+j+0H0YMGCEEMveao9eUGgxl4SK5pGUlCKFg6CFXEVR5HmM9rBKBLIy8pCenIecVPHgpVHRIS9DMQlBrtjmpiMrLRYXL2VgYrArGno56k8ugbp1PeHo6KDuFeS++zyEAdipeybooaaHmdiwYasIrV+TYfasWdMQHX20QB7v4VFDikXLlg/IsJ5Kx47tZJurq4s8platmsa6ORQZkFclDhz4UUQJ43Hq1B8inB4ptgcLXRMgA05Pz5BGW61aVURFRcso5plnxogIpp+MBggy8qJYtWq+DP/Xr9+C7OxsYfBCb0t4TUtQmhEcPFRGKySCZOwkGObCxmgXq0QgU0QBacm5SE/MRXZKHnKlGAghoOiAhECkBrdTHRAd64rW9c+gae0bGNK/gVxMLIm//oqToXRR/P13vDCAgg8+hbnmnuzrr3dKT1izZnOROy8U2xrGPN4A5ckuLs544ok+slCd2pycnGQ/5fYUJueHcm4HB9O6AUUDPXs+JQSjEV555XVkZGSKXPwtmYMbIIOjtIjC9MTEJJmyUIRCi3e0MEjzsrGxQWRklHqGJevWLRXevZf4DJ+KdOIzKQLCecuIpzgoxaB1jd9/DxcRxRuyjcSSrmWeejDaxbpIIDMPqcL4qaSLkn07D3lmQpCWao+bt9zQtOZN2ClZsM2JQ9f2DsIISg434+JuSGOmvNacH374Wnp0Clvt7GzRuXN7tUcPeXR6uE+fPiuN6rff9sp2Mj5aHKMwnMLnpk0by3aC8vtz56JEhNBdFqpTmwHyzomJyXIdwdxgaG7Vq1eTBrt9+waxPYLHHuso+9at24SQkHWyTqmBARqL8u/hw4fg00+/FPNoJKKC4zId2bv3oBCPYCluO3fuV88wQYISFBSINWs+lesfBKUKlJKQqBggEaN0wBARDRzYG++8M13ek6CgF4ye/88/r4h74WYURIp2KL0wnMdoC6tFID01F6nC+FNFWkCpQZYaEaQkOiIr1QZeromwzVagI6ctHi7v2mmoXtXkPYti48Zt0mvRQ0+r1WR8FNLTYtbhwz+L+mJh4CdEGP2kbCdvSlva//nnYzICoJV6MkB67UX99JqNCnnPmzfj1Svp2bPngPTsVKhuDhnNtm07Zd/nn6+UYz75ZF+Z/9PawaZN2+Rc6tatLV8TUj8VyutJqEjQzKGFTkp3xowZgddemyO8cR0899wr6Nq1k0xVKI3JH6LPmzcTL700TArAm28uUFv1nDkTKd+iTJz4gjTogIDuMpKiNQt6M7Fy5XwhUBcwaNAoi3HDwyOk4QcHPyXvD70ZoIgi/zoMoxnoa8NlKwcWjFd+HNdJOTatoxIx6xEl+r0uStzqbkrshl5K8rYAJXNPDyXnsL+S+6u/opwQJcJfSTjRTenZ1UupXq2acl/NmsqI4cMLHZtKixaPKfv2HVREDi0cv6KIB1gRBqdUqdJE9tev76vs2BGqiFDd2L916w7ZTv103IoVHyvx8QmKyH0VkTcr0dExypQps2R/RMQ5Wah+//2dFeHRZaF6/n4qs2cvVq5f/1uOJYREEV5d6dWL/pdmff/rr89Vrl2Llf1UYmOvK4sXrzb2m5dOnfoqu3f/IOdMFDaeeaF5FMbHH2+W9+nIkd/kGHRd+ozDho2T51F/YRg+19q1nxvnkJSULO+X+XW5aKeIJJ0qZWPf7CDo/jwqcmcFLq42cHIRxdUOrm46OLvZwLGKDWxddLBxFpGASK91DkBCdi4CX7mAyEtp0uv06dMHn28sGPoyDFOxWJUOZIt0QHGqhTzXOshQ3JHtWAeZNh5Iy6uONNRGanoVZOZ4IDvDBZnZNZGVWwupGeKY3Crw8fFB3Xr1jF8vZhimcrEF3Gar9VLzdNe2qBk4DDdvZ8OpdTfEK1UB73awbxWIs1dvI9WlETK8+iEvIwNXXQIRm14XVxJqoEHzx1DfuzG6+fkh5s9onD59SR2RYZjKwqpIIBd2OJ/mgMRaLXDuSjxu1XwAl7JcEH41CQm12+FSZg2cPXcOh5MfwKkbOYjOqIorto1x9q9EuDRuDafGbeDu7q6OxjBMZWLVmkDUiT04/uVm+Q1AFydb5NkqsLO3gbOTDXKErLg528LR0Qa29jrYOQAxiTnYcyIRGVl58i8NnZ1dMHLUSLRr11cdkWGYysIqEWAY5t7BqnSAYZh7BxYBhtE4LAIMo3FYBBhG47AIMIzGYRFgGI3DIsAwGodFgGE0ji50Vyh/WYhhNIyO/p5crUvy7TIMU8HQ/w5VkVikAywADFP5VLQd8poAw2gcFgGG0TgsAgyjcVgEGEbjWLwd4IVB5l6HnvGMjAz5Gw+V+bzTj9fQj9wU9ibgRPgptPO1/N2N8oQjAUZTpKeny5+Qq2yHR3MgMboTYBFgNEVhP2FXWdwpc2ERYJhK4k5Jv1kEGEbjsAgwjMZhEWAYjcMiwDAah0WAYTQOiwDDaJxy+8bgmzOnq7XCmbfgPbXGMBVHUlKyWrszqFq14G9yVvQ3BstNBLKzs9VaQWa//abcDho8BA+17yDrDFMRsAgUpNLSgYFPDsb2b75W9xiGqSz+9UjA4+0eaq0gT7XpiRUDpuLbHd/g5InjaiunBkzFwZFAQSo0Evgq/Hu5fUJEAbPnzJOFYZjKpdxEIH5OGF73D5bb70a9r7YCsZlJCIkJw4wL3+BC2nW1lWHuHnaFhspyr1BuIpCckYoxnQbL7fjtpnA/9OZpHE44j5ScTIw7u0Vt/WfE75yIbj16qiUEEWq7nnCsNPZNxJ44tVlg7XnFoR8z//HmY/XEtJ0lDxaxzHR8t3G7EK+2G4nbhWmlHIswH8/ynDjsGVdUXzEUdf2TIcaxCt7Tux8y/tNnImS5V4Sg3ERg0aHP4O7kig9/+QYxiaYHpY6jO27nZCA2KwmpuZlq6z8hHFuiRuNw2PeybH/1IsYajYYe8GnAUn3f4aVNsPA5w4Np7XlFoTf0BQhAkNpiIH7nIfhsVscKW4IGy4dj5Um1szCEgR3w2Wic2xqfEAxaFq52qgY9F+gRqDaUAAnTWCwp9PrxO+djoY953/wSBa/o64t7MPUiZqifVd5Ts3nf7RgEoHWrlrLcK0JQbiLwevdgnIm7iOndR8C7mqfaCsy7FIp+9z2Iyd5FLyCWjTaYMNm0iOLRIQAdIi8KMxbEHUMYJuFZX9kF+A7FjGbCwKQBWHteUYjxxIO/pL+Xum/Co/8k9DHegjbwF8Zz+UoxluYZiAn9TfespZ84IeqKMRpoOVkY2epAeKv7xROH3/YCM54xfNY2ePbV5th2UG+ccVFnEeRn6vMPPIuoEkSgyOvHXcHlZgF4WJ26vKdm8y47hUcpFhEciYyMSixFmo4pdVRTCswFILBvX1nuFSEoFxF4tJEvQs8eQbc1L+GLE/uxapDpi0Oj6nXB7r9P4XjKFbXlX0YIz9HA7mhpqPt4wUN2EJ7w9inCAK09r8zEISaqOXp0MBl5ScRfuYgOvdubzacsXEdUZBN4m13Ow6uJUVQ8fUyCQJ78wK7m8Cn91Czx9EKDyP34Tb1N8Uf357uPZYEEYDjCehsioiWQbkOkG4P2BmC7bBOFhNyzPXpYiLRe+Mpyj4sjvwAYMBeC78PC1Na7j3IRgSPRJzFuxyJZp+2ADVNknRgtRGD/Q5MxSUQCRx6eobb+S5BHoHBU9XpkPPmhh74A1p5nBRHLhovwe7RZZFAC9NAvb4KRZpFBmSDvrFaNeDaB4StaHv1XYLvPetWzrhdpy4rSz60AFA2NRtRzei89iNIts2irTKjR2Ezj526DPlSnuRsiNiOeeLh3c5NIy3NNEck/xdHRsYAAGDAIwd3Mvy4C9DaAStxbewst5YUMEUWeOjPM9BBLj5cPCn/Nsfa8sqNfMzjgp3qvUiBz74PdhcebpI9QrIG8s1o1QpGOviLD7QV4Q/W2bwBzy7A4mB+5KHgI/gYv7XdI7Fu5OFggGlMRqdKSpcBYKVqmsSn1wN5jMrqJ2BqCBi8GWhmBFKRnjx6FCoAB6qNj7lbKbU2gIiFDlg+yyFML/MNb5KQUigMNvPTWbu15ZYcEQG8cEwzrDCVAAlAWwSiei4gxs2sZ6ZCBkceMDDSLMjzRRxjPUdWYykrEwV3o8OpQk2CVai2lGIpaT/CdpBcZEgPDYi6lBKBUhFKaQPiX8j4z94IIiFB+gcgRTWGjGfQQIgRbDA/hyS+x0LDgZ+15VhCxjN40lMGbC49Kq/mlFYzioYVAYOFWU96/Zbm6UFggl9YbshQIdb8s0AKmhYBIkVHXGCwW70gUDa9R9dGI/m2FWd23O4IiQ7DAGJWEY0/+CMUiNaCUAAjbegiXDWs7TKmotL8iNNC27UMIemqoumcFFIJOFQ9uPoKWql6XHr7nQtTwNxBrDKG1teeVCD3g5rm1foFrYaTsNNFsErYXFoEIKEIZtDx/+tEcM/Ll6xQtfOKzEUsKEzILLOdg/IwSmu80bFP3ELikTOlK/utbzt1szvJ+XsRIeR/N75F+blEv0pzM63S+5dzkvIU4m/7d8t0T9d+sgcXns4S/NlwQ/vERRlOwCBSERaBM5POaKpaetfQU6vGLiRCKxSJyMVAweigt5OXH5g+UyhAl3KmwCBSERYDRFCwCBbkn3g4wDGM9LAIMo3FYBBhG47AIMIzGYRFgGI3DIsAwlYROp1NrlQuLAKMp7O3t1Frlc6fMhUWA0RTOzs7S+CrbCzs42MPJyUndq1z4y0IMcwdSkSLFkQDDaBwWAYbROCwCDKNxWAQYRuNYiMCd8t6SYbRMxdoh8P+iDNBzmzMALwAAAABJRU5ErkJggg=="},7973:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_all_items-2c57aff19d3b1ce52149c37f50dcaad8c30baa0c9931fdc629f1d163bb56ce96.png"},2428:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_all_mouseover-f6646df5320045ee10d4c0a15d0349fed6ede075f9cea6f9e449b3785c4f4f8d.png"},9720:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_temp1-7446e7c5b7869ccc9ddd467779fa86f44301a5e5896751b016a527587c483cb2.png"},9612:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table-2fc1bb4d03a2348c4af7df442e13cee2f310cf455228005d76cbfda7a706aa53.png"},9927:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table_raw-c4d454679c4503ec35710dcee6be5cd1940984595145b333d8604bc505dfe291.png"},2566:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table_temp1-ea091eaf8005cea839800f4514f72f94e9664993111b935f33e7c5aa3061ca64.png"},2978:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/open_config-55ef2f241d02047b252bb8201742f99cffed5680d0e9eb46b3cb53a644ca3dc9.png"},5387:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/processing-b0c50908284739a76e1bbcfcb3eb34dc9446f8716117cb0e9089ad9df53ebed6.png"},2236:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/save_config-0ae36ac1f8114665f2558e936ba3b30e5cba2a16cc01d3494e14ed689b4637f7.png"},1896:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_item-f063106a8d836656496ba81e7e7428f51bd8ab95aebab0aa4eb6ad41ed42e026.png"},8935:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_packet-be9d63c49f898cccb73f9e4b2b39c4b5879cead34a8ab2ede0bb08e953498e95.png"},6389:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_target-71ebcab6cbefafd8958939130861a75f7544e99a043d90fa0734ec2f983d835f.png"},9984:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/time_chooser-e4ca0705d5b97c3056b0de3ab7f71f8091482b9b2e8904e69866a43ce4e616f2.png"}}]);

data/tools/docs/assets/js/5109.6a372217.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5109],{5109:(e,t,n)=>{n.r(t),n.d(t,{default:()=>c});var a=n(2784),o=n(8004),l=n(5982),r=n(8659);function c(){return a.createElement(a.Fragment,null,a.createElement(l.d,{title:(0,o.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),a.createElement(r.Z,null,a.createElement("main",{className:"container margin-vert--xl"},a.createElement("div",{className:"row"},a.createElement("div",{className:"col col--6 col--offset-3"},a.createElement("h1",{className:"hero__title"},a.createElement(o.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),a.createElement("p",null,a.createElement(o.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),a.createElement("p",null,a.createElement(o.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"Please contact the owner of the site that linked you to the original URL and let them know their link is broken.")))))))}}}]);

data/tools/docs/assets/js/54d0d530.e9c8193b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7872],{4352:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var n=i(7896),o=(i(2784),i(876));const r={title:"Limits Monitor"},a=void 0,s={unversionedId:"tools/limits-monitor",id:"tools/limits-monitor",title:"Limits Monitor",description:"Introduction",source:"@site/docs/tools/limits-monitor.md",sourceDirName:"tools",slug:"/tools/limits-monitor",permalink:"/tools/docs/docs/tools/limits-monitor",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/limits-monitor.md",tags:[],version:"current",frontMatter:{title:"Limits Monitor"},sidebar:"defaultSidebar",previous:{title:"Handbooks",permalink:"/tools/docs/docs/tools/handbooks"},next:{title:"Packet Viewer",permalink:"/tools/docs/docs/tools/packet-viewer"}},l={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Limits Monitor Menus",id:"limits-monitor-menus",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Limits Tab",id:"limits-tab",level:2},{value:"Log Tab",id:"log-tab",level:2}],d={toc:c},m="wrapper";function u(e){let{components:t,...r}=e;return(0,o.kt)(m,(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The Limits Monitor application provides situational awareness for all telemetry items with limits. All limits items which violate their yellow or red limits are shown and continue to be shown until explicity dismissed. Individual items and entire packets can be manually ignored to filter out known issues. In addition, all limits events are logged in a table which can be searched."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Cmd Tlm Server",src:i(6609).Z,width:"1706",height:"1034"})),(0,o.kt)("h2",{id:"limits-monitor-menus"},"Limits Monitor Menus"),(0,o.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,o.kt)("p",null,"Limits Monitor has one menu under File -> Show Ignored:"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Ignored",src:i(8465).Z,width:"1064",height:"546"})),(0,o.kt)("p",null,"This dialog displays all the items which the user has manually ignored by clicking the ignore icons next to out of limits items. Note that entire Packets which have been ignored are listed as TARGET PACKET without an item (as shown by INST MECH). Ignored items are removed by clicking the Trash icon. This means that the next time this item goes out of limits it will be displayed."),(0,o.kt)("h2",{id:"limits-tab"},"Limits Tab"),(0,o.kt)("p",null,"The main interface of Limits Monitor is the Limits tab. This is where items are displayed when they violate a yellow or red limit."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Limits",src:i(6609).Z,width:"1706",height:"1034"})),(0,o.kt)("p",null,"Items with limits values are displayed using a red yellow green limits bar displaying where the current value lies within the defined limits (as shown by the various TEMP items). Items with yellow or red ",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry#state"},"states")," are simply displayed with their state color (as shown by GROUND1STATUS). The COSMOS Demo contains both INST HEALTH_STATUS TEMP2 and INST2 HEALTH_STATUS TEMP2 which are identically named items within different target packets. Limits Monitor only displays the item name to save space, however if you mouse over the value box the full target and packet name is displayed."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Mouseover",src:i(7571).Z,width:"1712",height:"166"})),(0,o.kt)("p",null,"Clicking the first nested 'X' icon ignores the entire packet where the item resides. Any additional items in that packet which go out of limits are also ignored by Limits Monitor. Clicking the second (middle) 'X' ignores ONLY that specific item. If any packets or items are ignored the Overall Limits State is updated to indicate \"(Some items ignored)\" to indicate the Limits State is potentially being affected by ignored items."),(0,o.kt)("p",null,"Clicking the last icon (eye with strike-through) temporarily hides the specified item. This is different from ignoring an item because if this item goes out of limits it will be again be displayed. Hiding an item is useful if the item has gone back to green and you want to continue to track it but want to clean up the current list of items. For example, we might hide GROUND1STATUS and GROUND2STATUS in the above example as they have transitioned back to green."),(0,o.kt)("h2",{id:"log-tab"},"Log Tab"),(0,o.kt)("p",null,"The Log tab lists all limits events. Events can be filtered by using the Search box as shown."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Log",src:i(43).Z,width:"1712",height:"1062"})))}u.isMDXComponent=!0},876:(e,t,i)=>{i.d(t,{Zo:()=>d,kt:()=>p});var n=i(2784);function o(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}function r(e,t){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),i.push.apply(i,n)}return i}function a(e){for(var t=1;t<arguments.length;t++){var i=null!=arguments[t]?arguments[t]:{};t%2?r(Object(i),!0).forEach((function(t){o(e,t,i[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(i)):r(Object(i)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(i,t))}))}return e}function s(e,t){if(null==e)return{};var i,n,o=function(e,t){if(null==e)return{};var i,n,o={},r=Object.keys(e);for(n=0;n<r.length;n++)i=r[n],t.indexOf(i)>=0||(o[i]=e[i]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)i=r[n],t.indexOf(i)>=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(o[i]=e[i])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),i=t;return e&&(i="function"==typeof e?e(t):a(a({},t),e)),i},d=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var i=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=c(i),h=o,p=m["".concat(l,".").concat(h)]||m[h]||u[h]||r;return i?n.createElement(p,a(a({ref:t},d),{},{components:i})):n.createElement(p,a({ref:t},d))}));function p(e,t){var i=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=i.length,a=new Array(r);a[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:o,a[1]=s;for(var c=2;c<r;c++)a[c]=i[c];return n.createElement.apply(null,a)}return n.createElement.apply(null,i)}h.displayName="MDXCreateElement"},8465:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/ignored-1e20d4ffe7fd88ffab610340957b1176294269f985e8fdb20a9af07d7a78215f.png"},6609:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/limits_monitor-c58d70daea7586b93d5069b9df068a90cea5f7cf2e51a445f3162bf3f66db3d0.png"},43:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/log-ba64fd307e53adafae55fcea7eb31829ee1aacdf4aafe8b40b270b793be3aa27.png"},7571:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/mouseover-95b774047b3c2ca23a3bc645caf75d90511c378729dd9cfb781510a1452e09fe.png"}}]);

data/tools/docs/assets/js/5bc719f6.fce76244.js

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

data/tools/docs/assets/js/5c6ce5ec.f909714f.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9366],{1624:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=n(7896),r=(n(2784),n(876));const i={title:"Streaming API"},o=void 0,s={unversionedId:"development/streaming-api",id:"development/streaming-api",title:"Streaming API",description:"This information is just generally used behind the scenes in COSMOS tools",source:"@site/docs/development/streaming-api.md",sourceDirName:"development",slug:"/development/streaming-api",permalink:"/tools/docs/docs/development/streaming-api",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/streaming-api.md",tags:[],version:"current",frontMatter:{title:"Streaming API"},sidebar:"defaultSidebar",previous:{title:"Roadmap",permalink:"/tools/docs/docs/development/roadmap"},next:{title:"Testing COSMOS",permalink:"/tools/docs/docs/development/testing"}},c={},l=[],p={toc:l},d="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("admonition",{title:"This documentation is for COSMOS Developers",type:"note"},(0,r.kt)("p",{parentName:"admonition"},"This information is just generally used behind the scenes in COSMOS tools")),(0,r.kt)("p",null,"The COSMOS 5 Streaming Api is the primary interface to receive a stream of the telemetry packets and/or command packets that have passed through the COSMOS system, both logged and continuously in realtime. Either raw binary packets or decommutated JSON packets can be requested."),(0,r.kt)("p",null,"This API is implemented over Websockets using the Rails ActionCable framework. Actioncable client libraries are known to exist for at least Javascript, Ruby, and Python. Other languages may exist or could be created. Websockets allow for easy interaction with the new COSMOS 5 Javascript based frontend."),(0,r.kt)("p",null,"The following interactions are all shown in Javascript, but would be very similar in any language.\nConnecting to this API begins by initiating an ActionCable connection."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"cable = ActionCable.createConsumer('/openc3-api/cable')\n")),(0,r.kt)("p",null,"This call opens the HTTP connection to the given URL and upgrades it to a websocket connection. This connection can then be shared with multiple \u201csubscriptions\u201d."),(0,r.kt)("p",null,"A subscription describes a set of data that you want the API to stream to you. Creating a subscription looks like this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'subscription = cable.subscriptions.create(\n  {\n    channel: "StreamingChannel",\n    scope: "DEFAULT",\n    token: token,\n  },\n  {\n    received: (data) => {\n      // Handle received data\n    },\n    connected: () => {\n      // First chance to add what you want to stream here\n    },\n    disconnected: () => {\n      // Handle the subscription being disconnected\n    },\n    rejected: () => {\n      // Handle the subscription being rejected\n    },\n  }\n);\n')),(0,r.kt)("p",null,"Subscribing to the StreamingApi requires passing a channel name set to \u201cStreamingChannel\u201d, a scope which is typically \u201cDEFAULT\u201d, and an access token (a password in OpenSource COSMOS). In Javascript you also pass a set of callback functions that run at various lifecycle points in the subscription. The most important of these are ",(0,r.kt)("inlineCode",{parentName:"p"},"connected")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"received"),"."),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"connected")," runs when the subscription is accepted by the StreamApi. This callback is the first opportunity to request specific data that you would like streamed. Data can also be added or removed at any time while the subscription is open."),(0,r.kt)("p",null,"Data can be added to the stream by requesting individual items from a packet or by requesting the entire packet."),(0,r.kt)("p",null,"Adding items to stream is done as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'var items = [\n  ["DECOM__TLM__INST__ADCS__Q1__RAW", "0"],\n  ["DECOM__CMD__INST__COLLECT__DURATION__WITH_UNITS", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n  this.subscription.perform("add", {\n    scope: window.openc3Scope,\n    token: localStorage.openc3Token,\n    items: items,\n    start_time: this.startDateTime,\n    end_time: this.endDateTime,\n  });\n});\n')),(0,r.kt)("p",null,"The values in the item name are separated by double underscores, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<ITEM NAME>__<VALUE TYPE>__<REDUCED TYPE>"),". Mode is either RAW, DECOM, REDUCED_MINUTE, REDUCED_HOUR, or REDUCED_DAY. The next parameter is CMD or TLM followed by the target, packet and item names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS. The last parameter is optional if you want to use the reduced data types. Reduced Type is one of SAMPLE, MIN, MAX, AVG, or STDDEV."),(0,r.kt)("p",null,"Adding packets to stream is done as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'var packets = [\n  ["RAW__TLM__INST__ADCS", "0"],\n  ["DECOM__TLM__INST__HEALTH_STATUS__FORMATTED", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n  this.subscription.perform("add", {\n    scope: window.openc3Scope,\n    token: localStorage.openc3Token,\n    packets: packets,\n    start_time: this.startDateTime,\n    end_time: this.endDateTime,\n  });\n});\n')),(0,r.kt)("p",null,"The values in the packet name are separated by double underscores, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<VALUE TYPE>"),". Mode is either RAW or DECOM. The next parameter is CMD or TLM followed by the target and packet names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS."),(0,r.kt)("p",null,"For Raw mode, VALUE TYPE should be set to RAW or omitted (e.g. TLM","_","_","INST","_","_","ADCS","_","_","RAW or TLM","_","_","INST","_","_","ADCS).\nstart_time and end_time are standard COSMOS 64-bit integer timestamps in nanoseconds since the Unix Epoch (midnight January 1st, 1970). If start_time is null, that indicates to start streaming from the current time in realtime, indefinitely until items are removed, or the subscription is unsubscribed. end_time is ignored if start_time is null. If start_time is given and end_time is null, that indicates to playback from the given starttime and then continue indefinitely in realtime. If both start_time and end_time are given, then that indicates a temporary playback of historical data."),(0,r.kt)("p",null,"Data returned by the streaming API is handled by the received callback in Javascript. Data is returned as a JSON Array, with a JSON object in the array for each packet returned. Results are batched, and the current implementation will return up to 100 packets in each batch (the array will have 100 entries). 100 packets per batch is not guaranteed, and batches may take on varying sizes based on the size of the data returned, or other factors. An empty array indicates that all data has been sent for a purely historical query and can be used as an end of data indicator."),(0,r.kt)("p",null,"For decommutated items, each packet is represented as a JSON object with a 'time' field holding the COSMOS nanosecond timestamp of the packet, and then each of the requested item keys with their corresponding value from the packet."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'[\n  {\n    "time": 1234657585858,\n    "TLM__INST__ADCS__Q1__RAW": 50.0,\n    "TLM__INST__ADCS__Q2__RAW": 100.0\n  },\n  {\n    "time": 1234657585859,\n    "TLM__INST__ADCS__Q1__RAW": 60.0,\n    "TLM__INST__ADCS__Q2__RAW": 110.0\n  }\n]\n')),(0,r.kt)("p",null,"For raw packets, each packet is represented as a JSON object with a time field holding the COSMOS nanosecond timestamp of the packet, a packet field holding the topic the packet was read from in the form of SCOPE","_","_","TELEMETRY","_","_","TARGETNAME","_","_","PACKETNAME, and a buffer field holding a BASE64 encoded copy of the packet data."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'[\n  {\n    "time": 1234657585858,\n    "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n    "buffer": "SkdfjGodkdfjdfoekfsg"\n  },\n  {\n    "time": 1234657585859,\n    "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n    "buffer": "3i5n49dmnfg9fl32k3"\n  }\n]\n')))}m.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),l=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=l(n),u=r,h=d["".concat(c,".").concat(u)]||d[u]||m[u]||i;return n?a.createElement(h,o(o({ref:t},p),{},{components:n})):a.createElement(h,o({ref:t},p))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,o[1]=s;for(var l=2;l<i;l++)o[l]=n[l];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}u.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/5e3ed378.cdfe0362.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7052],{1931:(e,t,a)=>{a.r(t),a.d(t,{default:()=>d});var l=a(2784),c=a(6277),n=a(5982),r=a(5138),m=a(8659),o=a(7133),s=a(7545);const i={mdxPageWrapper:"mdxPageWrapper_SLvB"};function d(e){const{content:t}=e,{metadata:{title:a,description:d,frontMatter:p}}=t,{wrapperClassName:_,hide_table_of_contents:g}=p;return l.createElement(n.FG,{className:(0,c.Z)(_??r.k.wrapper.mdxPages,r.k.page.mdxPage)},l.createElement(n.d,{title:a,description:d}),l.createElement(m.Z,null,l.createElement("main",{className:"container container--fluid margin-vert--lg"},l.createElement("div",{className:(0,c.Z)("row",i.mdxPageWrapper)},l.createElement("div",{className:(0,c.Z)("col",!g&&"col--8")},l.createElement("article",null,l.createElement(o.Z,null,l.createElement(t,null)))),!g&&t.toc.length>0&&l.createElement("div",{className:"col col--2"},l.createElement(s.Z,{toc:t.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level}))))))}}}]);

data/tools/docs/assets/js/5fe211ef.809c3f96.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4697],{4008:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:8,title:"Tables"},i=void 0,o={unversionedId:"configuration/table",id:"configuration/table",title:"Tables",description:"Table Definition Files",source:"@site/docs/configuration/table.md",sourceDirName:"configuration",slug:"/configuration/table",permalink:"/tools/docs/docs/configuration/table",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/table.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,title:"Tables"},sidebar:"defaultSidebar",previous:{title:"Protocols",permalink:"/tools/docs/docs/configuration/protocols"},next:{title:"Screens",permalink:"/tools/docs/docs/configuration/telemetry-screens"}},s={},u=[{value:"Table Definition Files",id:"table-definition-files",level:2},{value:"TABLEFILE",id:"tablefile",level:2},{value:"TABLE",id:"table",level:2},{value:"TABLE Modifiers",id:"table-modifiers",level:2},{value:"PARAMETER",id:"parameter",level:3},{value:"PARAMETER Modifiers",id:"parameter-modifiers",level:3},{value:"FORMAT_STRING",id:"format_string",level:4},{value:"UNITS",id:"units",level:4},{value:"DESCRIPTION",id:"description",level:4},{value:"META",id:"meta",level:4},{value:"OVERLAP",id:"overlap",level:4},{value:"KEY",id:"key",level:4},{value:"REQUIRED",id:"required",level:4},{value:"MINIMUM_VALUE",id:"minimum_value",level:4},{value:"MAXIMUM_VALUE",id:"maximum_value",level:4},{value:"DEFAULT_VALUE",id:"default_value",level:4},{value:"STATE",id:"state",level:4},{value:"WRITE_CONVERSION",id:"write_conversion",level:4},{value:"POLY_WRITE_CONVERSION",id:"poly_write_conversion",level:4},{value:"SEG_POLY_WRITE_CONVERSION",id:"seg_poly_write_conversion",level:4},{value:"GENERIC_WRITE_CONVERSION_START",id:"generic_write_conversion_start",level:4},{value:"GENERIC_WRITE_CONVERSION_END",id:"generic_write_conversion_end",level:4},{value:"OVERFLOW",id:"overflow",level:4},{value:"HIDDEN",id:"hidden",level:4},{value:"UNEDITABLE",id:"uneditable",level:4},{value:"APPEND_PARAMETER",id:"append_parameter",level:3},{value:"SELECT_TABLE",id:"select_table",level:2},{value:"DEFAULT",id:"default",level:2},{value:"Example File",id:"example-file",level:2}],p={toc:u},d="wrapper";function m(e){let{components:t,...a}=e;return(0,r.kt)(d,(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"table-definition-files"},"Table Definition Files"),(0,r.kt)("p",null,"Table definition files define the binary tables that can be displayed in COSMOS ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/tools/table-manager"},"Table Manager"),"\n. Table definitions are defined in the target's tables/config directory and are typically named after the table such as ",(0,r.kt)("inlineCode",{parentName:"p"},"PPSSelectionTable_def.txt"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"_def.txt")," extention helps to identify the file as a table definition. Table definitions can be combined using the ",(0,r.kt)("inlineCode",{parentName:"p"},"TABLEFILE")," keyword. This allows you to build individual table components into a larger binary."),(0,r.kt)("p",null,"The Table definition files share a lot of similarity with the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/command"},"Command Configuration"),". You have the same data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data."),(0,r.kt)("div",{style:{clear:"both"}}),(0,r.kt)("h1",{id:"table-keywords"},"Table Keywords"),(0,r.kt)("h2",{id:"tablefile"},"TABLEFILE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Specify another file to open and process for table definitions")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"File Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the file. The file will be looked for in the directory of the current definition file."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"table"},"TABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Start a new table definition")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the table in quotes. The name will appear on the GUI tab."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates if the data in this table is in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Display"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates the table contains KEY_VALUE rows (e.g. each row is unique), or a ROW_COLUMN table with identical rows containing different values.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"KEY_VALUE, ROW_COLUMN")),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"When Display is KEY_VALUE the remaining parameters are:"),(0,r.kt)("p",null,"| Description | Description of the table in quotes. The description is used in mouseover popups and status line information. | False |"),(0,r.kt)("p",null,"When Display is ROW_COLUMN the remaining parameters are:"),(0,r.kt)("p",null,"| Rows | The number of rows in the table | False |\n| Description | Description of the table in quotes. The description is used in mouseover popups and status line information. | False |"),(0,r.kt)("h2",{id:"table-modifiers"},"TABLE Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a TABLE keyword."),(0,r.kt)("h3",{id:"parameter"},"PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a parameter in the current table")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the table."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit offset into the table of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the table. Always use a bit offset of 0 for derived parameters."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("h3",{id:"parameter-modifiers"},"PARAMETER Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a PARAMETER keyword."),(0,r.kt)("h4",{id:"format_string"},"FORMAT_STRING"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds printf style formatting")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Format"),(0,r.kt)("td",{parentName:"tr",align:null},"How to format using printf syntax. For example, '0x%0X' will display the value in hex."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'FORMAT_STRING "0x%0X"\n')),(0,r.kt)("h4",{id:"units"},"UNITS"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Add displayed units")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Full Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Full name of the units type, e.g. Celsius"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviated"),(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviation for the units, e.g. C"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"UNITS Celsius C\nUNITS Kilometers KM\n")),(0,r.kt)("h4",{id:"description"},"DESCRIPTION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined description")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new description"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"meta"},"META"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Stores custom user metadata")),(0,r.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'META TEST "This parameter is for test purposes only"\n')),(0,r.kt)("h4",{id:"overlap"},"OVERLAP"),(0,r.kt)("div",{class:"right"},"(Since 4.4.1)"),"**This item is allowed to overlap other items in the packet**",(0,r.kt)("p",null,"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message."),(0,r.kt)("h4",{id:"key"},"KEY"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the key used to access this raw value in the packet.**",(0,r.kt)("p",null,"Keys are often JsonPath or XPath strings"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key string"),(0,r.kt)("td",{parentName:"tr",align:null},"The key to access this item"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"KEY $.book.title\n")),(0,r.kt)("h4",{id:"required"},"REQUIRED"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Parameter is required to be populated in scripts")),(0,r.kt)("p",null,"When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition."),(0,r.kt)("h4",{id:"minimum_value"},"MINIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined minimum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new minimum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"maximum_value"},"MAXIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined maximum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new maximum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"default_value"},"DEFAULT_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined default value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new default value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"state"},"STATE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a key/value pair for the current command parameter")),(0,r.kt)("p",null,"Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key"),(0,r.kt)("td",{parentName:"tr",align:null},"The string state name"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The numerical state value"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous / Disable Messages"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"HAZARDOUS")),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous Description"),(0,r.kt)("td",{parentName:"tr",align:null},"String describing why this state is hazardous"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_PARAMETER ENABLE 32 UINT 0 1 0 "Enable setting"\n  STATE FALSE 0\n  STATE TRUE 1\nAPPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"\n  STATE "NOOP" "NOOP" DISABLE_MESSAGES\n  STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"\n  STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"\n')),(0,r.kt)("h4",{id:"write_conversion"},"WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Applies a conversion when writing the current command parameter")),(0,r.kt)("p",null,"Conversions are implemented in a custom Ruby file which should be located in the target's lib folder and required by the target's target.txt file (see REQUIRE). The class must require 'openc3/conversions/conversion' and inherit from Conversion. It must implement the initialize method if it takes extra parameters and must always implement the call method. The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Class Filename"),(0,r.kt)("td",{parentName:"tr",align:null},"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional parameter values for the conversion which are passed to the class constructor."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"WRITE_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * multiplier\n    end\n  end\nend\n")),(0,r.kt)("h4",{id:"poly_write_conversion"},"POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"POLY_WRITE_CONVERSION 10 0.5 0.25\n")),(0,r.kt)("h4",{id:"seg_poly_write_conversion"},"SEG_POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a segmented polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Lower Bound"),(0,r.kt)("td",{parentName:"tr",align:null},"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n")),(0,r.kt)("h4",{id:"generic_write_conversion_start"},"GENERIC_WRITE_CONVERSION_START"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Start a generic write conversion")),(0,r.kt)("p",null,"Adds a generic conversion function to the current command parameter. This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent. The conversion is specified as ruby code that receives two implied parameters. 'value' which is the raw value being written and 'packet' which is a reference to the command packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of ruby code given should return the converted value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of ruby code for the conversion have been given."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("div",{class:"note warning"},(0,r.kt)("p",null,"Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance.")),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n")),(0,r.kt)("h4",{id:"generic_write_conversion_end"},"GENERIC_WRITE_CONVERSION_END"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Complete a generic write conversion")),(0,r.kt)("h4",{id:"overflow"},"OVERFLOW"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set the behavior when writing a value overflows the type")),(0,r.kt)("p",null,"By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be writen, e.g. you can successfully write 255 to a 8 bit signed value."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Behavior"),(0,r.kt)("td",{parentName:"tr",align:null},"How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"OVERFLOW TRUNCATE\n")),(0,r.kt)("h4",{id:"hidden"},"HIDDEN"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Indicates that the parameter should not be shown to the user in the Table Manager GUI")),(0,r.kt)("p",null,"Hidden parameters still exist and will be saved to the resulting binary. This is useful for padding and other essential but non-user editable fields."),(0,r.kt)("h4",{id:"uneditable"},"UNEDITABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Indicates that the parameter should be shown to the user but not editable.")),(0,r.kt)("p",null,"Uneditable parameters are useful for control fields which the user may be interested in but should not be able to edit."),(0,r.kt)("h3",{id:"append_parameter"},"APPEND_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a parameter in the current table")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the table."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("h2",{id:"select_table"},"SELECT_TABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Select an existing table for editing, typically done to override an existing definition")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Table"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the existin table"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"default"},"DEFAULT"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Specify default values for a SINGLE row in a multi-column table")),(0,r.kt)("p",null,"If you have multiple rows you need a DEFAULT line for each row. If all your rows are identical consider using ERB as shown in the OpenC3 demo."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Default values"),(0,r.kt)("td",{parentName:"tr",align:null},"A STATE value or data value corresponding to the data type"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h2",{id:"example-file"},"Example File"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Example File: TARGET/tables/config/MCConfigurationTable_def.txt")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'TABLE "MC_Configuration" BIG_ENDIAN KEY_VALUE "Memory Control Configuration Table"\n  APPEND_PARAMETER "Scrub_Region_1_Start_Addr" 32 UINT 0 0x03FFFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_1_End_Addr" 32 UINT 0 0x03FFFFFF 0x03FFFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_Start_Addr" 32 UINT 0 0x03FFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_End_Addr" 32 UINT 0 0x03FFFFF 0x03FFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Dump_Packet_Throttle_(sec)" 32 UINT 0 0x0FFFFFFFF 2 "Number of seconds to wait between dumping large packets"\n  APPEND_PARAMETER "Memory_Scrubbing" 8 UINT 0 1 1\n    STATE DISABLE 0\n    STATE ENABLE 1\n  APPEND_PARAMETER "SIOC_Memory_Config" 8 UINT 1 3 3\n  APPEND_PARAMETER "Uneditable_Text" 32 UINT MIN MAX 0xDEADBEEF "Uneditable field"\n    FORMAT_STRING "0x%0X"\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_State" 16 UINT MIN MAX 0 "Uneditable field"\n    STATE DISABLE 0\n    STATE ENABLE 1\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_Check" 16 UINT MIN MAX 1 "Uneditable field"\n    STATE UNCHECKED 0\n    STATE CHECKED 1\n    UNEDITABLE\n  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"\n  APPEND_PARAMETER "Pad" 16 UINT 0 0 0\n    HIDDEN\n')))}m.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>k});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),u=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=u(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(a),h=r,k=d["".concat(s,".").concat(h)]||d[h]||m[h]||l;return a?n.createElement(k,i(i({ref:t},p),{},{components:a})):n.createElement(k,i({ref:t},p))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=h;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,i[1]=o;for(var u=2;u<l;u++)i[u]=a[u];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/6831b732.735c11e9.js

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