openc3-cosmos-tool-docs 5.20.0 → 6.0.1

data/tools/staticdocs/assets/js/d5d77c37.1704d750.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["5360"],{6904:function(e,t,n){n.r(t),n.d(t,{default:()=>A,frontMatter:()=>r,metadata:()=>a,assets:()=>o,toc:()=>l,contentTitle:()=>d});var a=JSON.parse('{"id":"tools/cmd-tlm-server","title":"Command and Telemetry Server","description":"Status about interfaces, targets and log messages","source":"@site/docs/tools/cmd-tlm-server.md","sourceDirName":"tools","slug":"/tools/cmd-tlm-server","permalink":"/tools/staticdocs/docs/tools/cmd-tlm-server","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/cmd-tlm-server.md","tags":[],"version":"current","frontMatter":{"title":"Command and Telemetry Server","description":"Status about interfaces, targets and log messages","sidebar_custom_props":{"myEmoji":"\uD83D\uDEE0\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Command Sender","permalink":"/tools/staticdocs/docs/tools/cmd-sender"},"next":{"title":"Command History (Enterprise)","permalink":"/tools/staticdocs/docs/tools/command_history"}}'),s=n("2322"),i=n("2840");let r={title:"Command and Telemetry Server",description:"Status about interfaces, targets and log messages",sidebar_custom_props:{myEmoji:"\uD83D\uDEE0\uFE0F"}},d=void 0,o={},l=[{value:"Introduction",id:"introduction",level:2},{value:"Command and Telemetry Server Menus",id:"command-and-telemetry-server-menus",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Interfaces Tab",id:"interfaces-tab",level:2},{value:"Targets Tab",id:"targets-tab",level:2},{value:"Command Packets Tab",id:"command-packets-tab",level:2},{value:"Telemetry Packets Tab",id:"telemetry-packets-tab",level:2},{value:"Status Tab",id:"status-tab",level:2},{value:"Log Messages",id:"log-messages",level:2}];function c(e){let t={a:"a",h2:"h2",h3:"h3",img:"img",p:"p",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsxs)(t.p,{children:["The Command and Telemetry Server application provides status about the ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/interfaces",children:"interfaces"})," and targets instantiated in your COSMOS installation. Interfaces can be connected or disconnected and raw byte counts are returned. The application also provides quick shortcuts to view\nboth raw and formatted command and telemetry packets as they go through the COSMOS system. At the bottom of the Command and Telemetry Server is the Log Messages showing server messages."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Cmd Tlm Server",src:n(6738).Z+"",width:"2788",height:"2052"})}),"\n",(0,s.jsx)(t.h2,{id:"command-and-telemetry-server-menus",children:"Command and Telemetry Server Menus"}),"\n",(0,s.jsx)(t.h3,{id:"file-menu-items",children:"File Menu Items"}),"\n",(0,s.jsx)(t.p,{children:"The Command and Telemetry Server has one menu under File -> Options:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"File Menu",src:n(1293).Z+"",width:"302",height:"114"})}),"\n",(0,s.jsx)(t.p,{children:"This dialog changes the refresh rate of the Command and Telemetry Server to reduce load on both your browser window and the backend server. Note that this changes the refresh rate of the various tabs in the application. The Log Messages will continue to update as messages are generated."}),"\n",(0,s.jsx)(t.h2,{id:"interfaces-tab",children:"Interfaces Tab"}),"\n",(0,s.jsx)(t.p,{children:"The Interfaces tab displays all the interfaces defined by your COSMOS installation. You can Connect or Disconnect interfaces and view raw byte and packet counts."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Interfaces",src:n(983).Z+"",width:"1259",height:"431"})}),"\n",(0,s.jsx)(t.h2,{id:"targets-tab",children:"Targets Tab"}),"\n",(0,s.jsx)(t.p,{children:"The Targets tab displays all the targets and their mapped interfaces along with the Command Authority status (Enterprise Only)."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Targets",src:n(7090).Z+"",width:"2212",height:"1058"})}),"\n",(0,s.jsx)(t.p,{children:"Command Authority is enabled in the Admin Console and is enabled scope wide. Once Command Authority is enabled, individual users can give and take Command Authority which enables exclusive command and script access to that target. Without Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Command Authority",src:n(1235).Z+"",width:"2788",height:"1282"})}),"\n",(0,s.jsx)(t.p,{children:"The other option shown in the Scope List is the Critical Command Mode. Critical commanding requires a different user to approve each command. It can either be enabled on just HAZARDOUS and RESTRICTED commands or on all manual commanding."}),"\n",(0,s.jsx)(t.p,{children:"Here is an example of sending a HAZARDOUS command in Command Sender when Critical Command Mode is set to NORMAL."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Critical Command",src:n(6997).Z+"",width:"2288",height:"758"})}),"\n",(0,s.jsx)(t.h2,{id:"command-packets-tab",children:"Command Packets Tab"}),"\n",(0,s.jsx)(t.p,{children:"The Command Packets tab displays all the available commands. The table can be sorted by clicking on the column headers. The table is paginated to support thousands of commands. The search bar searches all pages for a command."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Commands",src:n(5705).Z+"",width:"1259",height:"718"})}),"\n",(0,s.jsx)(t.p,{children:"Clicking on View Raw opens a dialog displaying the raw bytes for that command."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Raw Command",src:n(6226).Z+"",width:"782",height:"301"})}),"\n",(0,s.jsxs)(t.p,{children:["Clicking View in Command Sender opens up a new ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/tools/cmd-sender",children:"Command Sender"})," window with the specified command."]}),"\n",(0,s.jsx)(t.h2,{id:"telemetry-packets-tab",children:"Telemetry Packets Tab"}),"\n",(0,s.jsx)(t.p,{children:"The Telemetry Packets tab displays all the available telemetry. The table can be sorted by clicking on the column headers. The table is paginated to support thousands of telemetry packets. The search bar searches all pages for a telemetry packet."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Telemetry",src:n(5084).Z+"",width:"1259",height:"718"})}),"\n",(0,s.jsx)(t.p,{children:"Clicking on View Raw opens a dialog displaying the raw bytes for that telemetry packet."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Raw Telemetry",src:n(4834).Z+"",width:"782",height:"406"})}),"\n",(0,s.jsxs)(t.p,{children:["Clicking View in Packet Viewer opens up a new ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/tools/packet-viewer",children:"Packet Viewer"})," window with the specified telemetry packet."]}),"\n",(0,s.jsx)(t.h2,{id:"status-tab",children:"Status Tab"}),"\n",(0,s.jsx)(t.p,{children:"The Status tab displays COSMOS system metrics."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Status",src:n(1218).Z+"",width:"1259",height:"718"})}),"\n",(0,s.jsx)(t.h2,{id:"log-messages",children:"Log Messages"}),"\n",(0,s.jsx)(t.p,{children:"The Log Messages table sits below all the tabs in the Command and Telemetry Server application. It displays server messages such as limits events (new RED, YELLOW, GREEN values), logging events (new files) and interface events (connecting and disconnecting). It can be filtered by severity or by entering values in the Search box. It can also be paused and resumed to inspect an individual message."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Log Messages",src:n(6044).Z+"",width:"2788",height:"1172"})})]})}function A(e={}){let{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},1235:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png"},5705:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png"},6226:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/cmd_raw-28307ac400b66050ada7ecc8b7701deffe8fb7f01129b63ec35a54857cb886b7.png"},6738:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png"},6997:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png"},1293:function(e,t,n){n.d(t,{Z:function(){return a}});let a="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAS4AAAByCAYAAADtezx7AAAKqWlDQ1BJQ0MgUHJvZmlsZQAASImVlwdQU+kWgP9700MCgQQEpIQaivQWQErooUY6iEpIAoQSQiCo2JXFFVxRRERAEXRVRMFVKWJHFNuioALWBVlElHWxYMPyLjCE3X3z3pt3Zs6cb849//nP/889d84FgEzhisVpMAWAdFG2JNTXgx4dE0vHDQMSUAAUYAjUuLwsMYvDCQSIzNi/y/seAE3aO2aTuf79+X8VRb4giwcAxEE4gZ/FS0f4JKIveGJJNgCovYhfb2m2eJLbEaZJkAIR7pvkpGkeneSEKUaDqZjwUE+EaQDgSVyuJAkAEh3x03N4SUgekjvCliK+UISwGGHX9PQMPsLHEDZCYhAfaTI/M+EveZL+ljNBlpPLTZLx9FmmBO8lzBKncZf/n9fxvyU9TTqzhyGipGSJXyhilZA760vNCJCxKCE4ZIaF/Kn4KU6W+kXMMC/LM3aG+VyvANnatODAGU4U+rBlebLZ4TMsyPIOm2FJRqhsr0SJJ2uGuZLZfaWpETJ/soAty5+bHB41wznCyOAZzkoNC5iN8ZT5JdJQWf0Cka/H7L4+srOnZ/3lvEK2bG12crif7Ozc2foFItZszqxoWW18gZf3bEyELF6c7SHbS5zGkcUL0nxl/qycMNnabOSFnF3Lkd1hCtefM8PAD3AAHUQi1hrYAkvABSBbsCx78iCeGeLlEmFScjadhXSYgM4W8czn0a0trW0AmOzX6dfhbd9UH0Iq+FkffwgAm8meMpr1pSDdfvo90nqNsz7GAACU3QBc4PCkkpxp31QvYQAR+RLQgBrQAnrACJgh1dkDZ+AOvIE/CAHhIAYsBjyQDNKBBCwFK8E6kA8KwVawA5SDKrAPHAJHwXHQDM6Ai+AKuAFug3vgIegHQ+AlGAPvwQQEQTiIDFEhNUgbMoBMIWuICblC3lAgFArFQPFQEiSCpNBKaANUCBVD5VA1VAv9Ap2CLkLXoC7oPjQAjUBvoM8wCibBNFgTNoQtYCbMggPgcHgRnARnwrlwHrwFLoNr4CNwE3wRvgHfg/vhl/A4CqDkUCooHZQZionyRIWgYlGJKAlqNaoAVYqqQdWjWlEdqDuoftQo6hMai6ai6WgztDPaDx2B5qEz0avRm9Hl6EPoJnQ7+g56AD2G/oYhYzQwphgnDBsTjUnCLMXkY0oxBzCNmMuYe5ghzHssFquCZWAdsH7YGGwKdgV2M3Y3tgF7AduFHcSO43A4NZwpzgUXguPisnH5uF24I7jzuG7cEO4jXg6vjbfG++Bj8SL8enwp/jD+HL4bP4yfIFAIBgQnQgiBT1hOKCLsJ7QSbhGGCBNERSKD6EIMJ6YQ1xHLiPXEy8RHxLdycnK6co5yC+SEcmvlyuSOyV2VG5D7RFIimZA8SXEkKWkL6SDpAuk+6S2ZTDYku5NjydnkLeRa8iXyE/JHeaq8uTxbni+/Rr5Cvkm+W/6VAkHBQIGlsFghV6FU4YTCLYVRCoFiSPGkcCmrKRWUU5ReyrgiVdFKMUQxXXGz4mHFa4rPlXBKhkreSnylPKV9SpeUBqkoqh7Vk8qjbqDup16mDtGwNAaNTUuhFdKO0jppY8pKyrbKkcrLlCuUzyr3q6BUDFXYKmkqRSrHVXpUPs/RnMOaI5izaU79nO45H1TnqrqrClQLVBtU76l+VqOreaulqm1Ta1Z7rI5WN1FfoL5UfY/6ZfXRubS5znN5cwvmHp/7QAPWMNEI1VihsU/jpsa4ppamr6ZYc5fmJc1RLRUtd60UrRKtc1oj2lRtV22hdon2ee0XdGU6i55GL6O308d0NHT8dKQ61TqdOhO6DN0I3fW6DbqP9Yh6TL1EvRK9Nr0xfW39IP2V+nX6DwwIBkyDZIOdBh0GHwwZhlGGGw2bDZ8zVBlsRi6jjvHIiGzkZpRpVGN01xhrzDRONd5tfNsENrEzSTapMLllCpvamwpNd5t2zcPMc5wnmlczr9eMZMYyyzGrMxswVzEPNF9v3mz+ykLfItZim0WHxTdLO8s0y/2WD62UrPyt1lu1Wr2xNrHmWVdY37Uh2/jYrLFpsXlta2orsN1j22dHtQuy22jXZvfV3sFeYl9vP+Kg7xDvUOnQy6QxOczNzKuOGEcPxzWOZxw/Odk7ZTsdd/rT2cw51fmw8/P5jPmC+fvnD7rounBdql36Xemu8a57XfvddNy4bjVuT9313PnuB9yHWcasFNYR1isPSw+JR6PHB08nz1WeF7xQXr5eBV6d3kreEd7l3k98dH2SfOp8xnztfFf4XvDD+AX4bfPrZWuyeexa9pi/g/8q//YAUkBYQHnA00CTQElgaxAc5B+0PehRsEGwKLg5BISwQ7aHPOYwOJmc0wuwCzgLKhY8C7UKXRnaEUYNWxJ2OOx9uEd4UfjDCKMIaURbpEJkXGRt5Icor6jiqP5oi+hV0Tdi1GOEMS2xuNjI2AOx4wu9F+5YOBRnF5cf17OIsWjZomuL1RenLT67RGEJd8mJeEx8VPzh+C/cEG4NdzyBnVCZMMbz5O3kveS780v4IwIXQbFgONElsTjxeZJL0vakkWS35NLkUaGnsFz4OsUvpSrlQ2pI6sHU72lRaQ3p+PT49FMiJVGqqD1DK2NZRpfYVJwv7s90ytyROSYJkBzIgrIWZbVk05DB6KbUSPqDdCDHNaci5+PSyKUnlikuEy27udxk+ablw7k+uT+vQK/grWhbqbNy3cqBVaxV1auh1Qmr29borclbM7TWd+2hdcR1qet+XW+5vnj9uw1RG1rzNPPW5g3+4PtDXb58viS/d6Pzxqof0T8Kf+zcZLNp16ZvBfyC64WWhaWFXzbzNl//yeqnsp++b0nc0llkX7RnK3araGvPNrdth4oVi3OLB7cHbW8qoZcUlLzbsWTHtVLb0qqdxJ3Snf1lgWUtu/R3bd31pTy5/F6FR0VDpUblpsoPu/m7u/e476mv0qwqrPq8V7i3r9q3uqnGsKZ0H3Zfzr5n+yP3d/zM/Ln2gPqBwgNfD4oO9h8KPdRe61Bbe1jjcFEdXCetGzkSd+T2Ua+jLfVm9dUNKg2Fx8Ax6bEXv8T/0nM84HjbCeaJ+pMGJysbqY0FTVDT8qax5uTm/paYlq5T/qfaWp1bG0+bnz54RudMxVnls0XniOfyzn0/n3t+/IL4wujFpIuDbUvaHl6KvnS3fUF75+WAy1ev+Fy51MHqOH/V5eqZa07XTl1nXm++YX+j6abdzcZf7X5t7LTvbLrlcKvltuPt1q75Xee63bov3vG6c+Uu++6Ne8H3unoievp643r7+/h9z++n3X/9IOfBxMO1jzCPCh5THpc+0XhS85vxbw399v1nB7wGbj4Ne/pwkDf48ves378M5T0jPysd1h6ufW79/MyIz8jtFwtfDL0Uv5wYzf9D8Y/KV0avTv7p/ufNseixodeS19/fbH6r9vbgO9t3beOc8Sfv099PfCj4qPbx0Cfmp47PUZ+HJ5Z+wX0p+2r8tfVbwLdH39O/fxdzJdypUQCFKJyYCMCbgwCQYwCg3gaAuHB6np4SaPofYIrAf+LpmXtK7AFAUiHjDgCh7gBUIspAVGEtABzEhrsD2MZGpjOz79ScPim68gDYViCTA9Tn3Q3+KdMz/F/q/qcFsqx/s/8ChOcBmClFzDgAAABWZVhJZk1NACoAAAAIAAGHaQAEAAAAAQAAABoAAAAAAAOShgAHAAAAEgAAAESgAgAEAAAAAQAAAS6gAwAEAAAAAQAAAHIAAAAAQVNDSUkAAABTY3JlZW5zaG90nlxVngAAAdZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8ZXhpZjpQaXhlbFlEaW1lbnNpb24+MTE0PC9leGlmOlBpeGVsWURpbWVuc2lvbj4KICAgICAgICAgPGV4aWY6UGl4ZWxYRGltZW5zaW9uPjMwMjwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlVzZXJDb21tZW50PlNjcmVlbnNob3Q8L2V4aWY6VXNlckNvbW1lbnQ+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgpFlOPSAAAUBklEQVR4Ae2dCXgUVbbHT5LubJCQPYQAYd+DCCg4goBBWQZZlNVRQT6UeejAMONTYHw+3iDz6TeO6DwHGVcUfCLogOgIOgRl32STHQIhkBCyAIEEErK+cy5W0/R0Jd1JJVSn/5eP1Hbq1rm/Sv9z7rnVt3zi23WtKPHxp/IKQgEBEAABUxPw9SGyVhSTr+hVOfEWCgiAAAiYnICmVb5ELF0VCLdMfr/gHgiAgBBgrZJ/LFwoIHCDgNViMQyFn5+fYXWhIhBwJGDcb6pjzdj2CAIWix9NePgh6t61M0VGhFPKqTT614bNtG3XXpf9Dw4OooiwMEo/l6nOaR7fhObNmUkzX5xPFy/luVwPDEHAVQJ+IZGxc8sI+uUqsPpm99Tj46lNqxb0zkfL6Iuvv6Wi4mKaNP4ROn0mg7Jycl1qbo87EmnG0xPp6+/WK/uCa9fo+MlUOpN+zqXzYQQC7hDwqygjv5AIFi4fCJc74OqLbcd2renxsSPptbfepVNpZ6no+nVKO5vBaYQKGj18MK1N3qia2rNbotrXumUC3dPjTgoJaUiZWdnqWGLH9hytdaIWzePpSn4B5RdcJR8e62nLYpieeZ7Ky8uVXQOOyiSq63FHF/L19aXcC5dsGKV+H/4XFxtD99zVXZ1zMe+y7bishIWG0L29elJsVCTlXrxEpWVltxzHhvcQ8COEWt5zt520tFVCc7rCQnOaxcq+7Ni9n8aPGkYhDRsoIRoxZCCFslidz86hktIyGjNiCHcnt9DiT7+g6KgIiooMV2KU0DSeUlLTqEFQEE15bCz9uO8AlZSUUmR4GM19YQYVF5dQWnoGnz+Uvlu/iZasWKUuK/VLfu06H5cob+TQB+jb7zfRii+/UccTO7Wn6U9NpF17f6KwRqE0ddIEen7uq5Rz4aK921j3IgIItbzoZjs2NaFZPB05nqKiKftjF/Nu5KWaN21Ch46eUIdk+c7Hy9R67553KmFa8tlKWr9pG10rLKKWzZvR4mVfqOOS47IvTz0xjrue6bRg0YcqmpJobO7z02n77n104tRpZZqde0Edl2hv0IC+lNTvXptw/fKBAfTDlu30yeerle2kCY9Q184dKHnjVvvLYN1rCKhRRTwK4TX326Ghftxlky6aY6n4+WlkX5+bg84SbWllz/6DZOEISXJjVRXpFrZr3VJFX1q3UcQqh7uKnTu0tZ0ukZqIlhSJAOMbx5A2Mnny9BnVTRw+OIlio6NUpAfRsqHzyhVEXF552280WrptQwb255yUj0005EgEd+2kyHFnpbikhLuQBdSExeVYyilnJrZ9DRsEU4C/P2VkZtn2yUoOR1hyrLIiuTIp0mWUiK13z27cjXxQ+bXwg6VcB7qKNwh538+bf1K9r+1e3+KTqWcolPNY0iW0L93v6EySHJdku7MSHRnBjz80osPHUpwdvmWf1CFJfxkI0IrVaqG2rVvwQEDVo44SFUqO69CxE/S/735M055/SXU3x474pVYdll5IAMLlhTdda/Jhzm/t2LOfJj86huLjYsnfaiUZ4Xt42CD6mPNX9qVX927UiEf2JEkvx89n59oel7jEIhcYGMARVAP7U2zr6zZspQF9elOn9m1UlCWJ/6vXCunA4aM2G72VMh6VlMczfvXIcAoMCFBm0pU9n3Wz66p3LvbXTwKSUbCovMK/pznqZ4vRqlsIyL1/+8NPaCILw5yZ05QwneVnr5b942s1gmdvfDk/n+b/4fdKnAqLimjh+0tthyVnlZqWTm+/9kf623tL6Nz5G49KaAaff7WGgljYXpg+lbukRGczztGf+RGMvCv5mkmlywWLPqBpkx+jRX+Zp0YmJdJbs35DpefgYH0mUEE+cW06V5T4BtXnVqJtLhCQPFdQUCBd40jIscybPVMJ2eq1ySrikme1tES6va08PlFw9ZrTY2InyfYAf6sahbQ/z9X1oMBAkvxaGZ7hchVZvbSzlhfikfl6eWer0SgRImei5ViVXt5L7ETQKisiONcKq//gqER6KCAgBJDjwu9BlQTkKfeqRKnKSmAAAgYSQFfRQJioCgRAoPYJSFfRV6bjQgEBEAABjyHAmoWuosfcLTgKAiBwgwC+8oPfBBAAAQ8koOac90C/4TIIgICXEpDslvquoiUAz3F56e8Amg0CnkeAJ6pEjsvzbhs8BgGvJwDh8vpfAQAAAc8jAOHyvHsGj0HAywnIqKJ86xUFBEAABDyFAJ7j8pQ7BT9BAATsCaCraE8D6yAAAh5BAMLlEbcJToIACNgTgHDZ08A6CICARxCAcHnEbYKTIAAC9gQgXPY0sA4CIOARBCBcHnGb4CQIgIA9AQiXPQ2sgwAIeAABTGvjATcJLoIACDgSQMTlSATbIAACpicA4TL9LYKDIAACjgQgXI5EsA0CIGB6ArdFuOTlow2Cg00P53Y6GBkeRo2jo2rsQquEZhTML3pFAYH6QkDmhaiWcInwjB0xRP0f89BguqtbFwrkV6y7UhI7tKU/v/Qc/fbpJ1wxr9Jm+pTHaECfXlXajRySROGNQqu0qyuDiWNH0qghA51eLioinJ6b9iSVlZc7Pe7OTnkJ68ypkyBe7kCDrekJVFu4hg3sR1f5des5Fy5SYsd2tOB/ZlGzJo2rbPDg+/vSym/W0fw3FlVpa6TBoP59qFFoSKVV+lut9Dq3Q5a3s4wdMZjWrN+k2NbUj7T0c7T34GES7iggUF8IVEu4tMZv272Pfti6kz749B9qeX+f3tohatggmO7p2Y3uujORLH5+an/3xE7UqkUzCuPIp3l8nIoCunXpSPFxsXTv3d2VjcVioa6d2lPfXj0oNKShrT5ZEWHsw/udRU4Sycn1Avz9bznH2UaPrp1VV7VX965KdH19fXk7iO5mX6MiwpTP4r8UPX+kjujICOr/i7tVm1o2b2q7VERYI+rcvo3a9uO2Sxv7cPtCGjaw2eitxEZHUpsWCbRx24/KpF2rFuxTON2Z2JH63XMXhYeFkr+/lXre0ZmEp8ZWjKUdndq1Vv4HBtzksGn7brr/3l5kv0/v+tgPAp5AwCL9RR8DPC0vr1BiJVXFREXSrN9Mof2HjlFsTCT1692TXnv7Q4rhD6Uff7jkAy8f4gq++LOTH6Xz2bl06FgK7bRaaNazT9Hl/Hy6VlhEjwx7kGbNf52Kiq7TaF5v36YVHT+ZqtYXf7aK9h08ojyX6O/g0RQKDg6kcdyFnfnSK6puvWZN+dVoyszKoZTTadS2ZYISlU9X/pMax9zIKcXx8shxK1kr8UfquJJfQKlnMyj/6lXl0+z5C9QlH+j3C7U8fPwkzZn+NOVdyVdtHD9qKL361vt0NiNTzzXq1rkDnck4Zzs+JKkvNWXBlrYK11FDByrfz7H/4uewB/rTH19fqOz/MGMqZXMEfJVfJjBp3EgSf8TH/IKrJPbCb/+ho7a6sQICnkrAIgJSUE3v7+6WyB+SQpIEsEQECxd/qmoax12d9Zt30Nf/+oEkH/aXuS8ooVrL3Z+h3GVZv3k7fzgzVQRVznmcP735dyVUA++7h4quX6e/vrdU1fPrieOpS/u29OP+gyrSWvTRZ3Q05RR3fY6oKERze/POPar7KdvS1WvRLJ5Sz6Rrh50uV3y1lo6cOKXqmT97Br2zZDmt/u57Gj7ofrUsLi6hyvyRShcvX8UCd1K18fHRwykuNlqJiuT83uQ2BAUG0uaduzka3aWEtKKinPpz1LTk89VOfZKdMZyQTz2Tccvx75nlN8kb1XXefHkO/XT4mOpKSjT49isvkUR4FosfJTRrwsL4HhWXlNCptHT+AxGuhEsqu3Apj2L4DwYKCHg6AdEsi/w19mlYvRG+uNgYJTTdu3aiFavXcjR0WjFp3aI5RUdFqC6f7AgIsFIX7spt+3GfOm7/43pxsRIt2SfnSdQzhyMHKdItKubjIlySF3tm8gQ6cSqNduz5Sf1XRvxDIhqt5F2+orqSqdoOnaV2jtiLwEj3yzEZXpk/Uq2cK0Uix6279nJXsyvtOXCYfS6xRVWZWbn0xJgR1LxpHIWFhlJKapo6R+9HBLfZUXQl+pQi17nIApTJEaqU0tJSKuDoSrrUksvawgL+2n//J/twRPlz8vRZZSc/LjOjiPBGtm2sgICnEhDNstTE+S+/TeYP0mX1IR2adB9t4Q+vfLik27hu4zY6euKmfBRwd6qqUsHRl3T5/rlug81UhE3Khm271AezCw8EDH9wALVtlUBLP//KZlcbK5X543g9EY1nnnyU/Px8FQc5Lo8h/Mek8bTg7x8pYXmQu5ASnVZWLl8poJCf82uV2TkeE+4fLltJy4PXcv6rC4v8o8xnNe3ad1CZimhJFIYCAvWBQI2S8xoAESzux1Df3j3UrgNHjqvE8RXOVWXnXqD2rVuoxLFmr7c8cOQEJ8vbUmlZqTpPEuVhPBIoAvC3V/5Ldesk17Nx+y6KjjC+21NWVs7XLuMkdsDP7XDujzP/M85nU2l5mUrWa5GldB1FUNIzs1jQ/EhEV5aVlewLFzjSdD8ykpHdP83+LV2/XqxEXrrB8iyYVprGNVZMtW0sQcCTCdQo4tIaLh/O5dxVnDx+FG3fvZ/X19DUx8fRgnmzqYAfmTjBXUjtw6yd42wpo5TSpXr1xd+rSE7OfeuDT1RXcvmXa+nF3/1aJZqL+MP5ESfnjS7yzJN0+V6eNYP++u4S0vNH77pbd+7lXF8nuph3WZlIV00GHd6YN0vlvnIv5lFTHkGtrBziiFNye+6Ww3ydY8z5DWaez9ykSykjvlJELCUPJt1sFBCoDwR8Ylt2qPBpGF0rbZFHE0QMJIpxp8jIo5VzTjKa6FjkQVdn+x3tarItEV4hX1sEWUpl/rhyHRmdLCkpdcVU2Tw3bTKtWrOO82FnXD5HMxRf/ThRL3k2rQzhARGJvpZ+Ubtda+16WIJAbRKoKMip3pPzrjol+Sl3RUvqliS5njjp7XfVJ1fsJBmuiVZV/rhSnzuiJfV9tuobklHK6nxVR9jZi1aTxjF0H49kfsUjvCggUF8I1GrEVV8g3Y52JDRtoi4ro4U1KfJgruTftO5rTerCuSBgBgIScUG4zHAn4AMIgIDLBGq9q+iyJzAEARAAATcIGPI4hBvXgykIgAAI1JgAhKvGCFEBCIBAXRMw5DmuunYa1wMBEDAXgU7R1Z8K6nDOzUd3XG0VIi5XScEOBEDANAQgXKa5FXAEBEDAVQKGdBXlqewObVvyl6D5O4sOJZSnoJAJBhN4qpk0nrsqmae0kW932xejbOzrxDoIgED9JVDt57isPBdUEs+fJRP3JfXtTd9v2UETfzP7FlLy1PaKdxeo2UYPHj2hprmRL16PnjKTJ9bLUbZG2dxyYWyAAAjUKYHKclzJycmUlJSk64+7Oa4aPcf15vw5tJBnbJB559PPZTl1SqZ5kfnb+z88kR575nnqP+oJ/hpLEE17coLN3igbW4VYAQEQMA0BES0p2tIox6qd45IZQxP7j6Bn57xMWTm5/N2+f3dJphVeuSbZNuGefO3ky7Xr1SyomrVRNlp9WIIACJiDgKNYOW7XxMtqC9e+g0fVtM16F5eXOMjUwY7ftTt7LpPnoY9S83MZZaPnA/aDAAjcHgJ6IqW3310vDUnOO7uoTLss881LV9K+5BdcU2+mkemGrTz9ihE22hTK9tfBOgiAwO0jUFlOywivqh1xVXVxeVWWlAr+Z1+0bdY026yo2j7NTtt21UY7D0sQAAHvIFBrEZe8aUaKvInGvshEd1KKim7MJS/rRtlIXSggAAL1n8CtqmJgey/lXVHzn8uUwfZFnvmSKZkLi4rUf5kjvaY29vVjHQRAoP4TqLWuoqA7fuo0yTsG7Yu8f1H2a8UoG60+LEEABOo/gVoVLnmhxWCe73zMQ4NVVCVvph40oM8trxUzyqb+3yq0EAQ8h4CMHur9N6IVtdZVFOf+j19rL6+Pf+XF36n502Uu97fe/4SW8ZzqWjHKRqsPSxAAgdtPQEYVnT36YNRoY7W/8uMOGhlhjImKVO/1K+eXOTgrRtk4qxv7QAAEapeA3ld+7MVLT7Tq9Cs/7mAQsZLvJuqJltRllI07fsEWBECgdgloYqUtjbparea4jHIS9YAACHguAaNFS0hAuDz39wGeg4DXEoBwee2tR8NBwHMJ1OqooudigecgAALuEHA3we5O3c5sEXE5o4J9IAACpiYA4TL17YFzIAACzghAuJxRwT4QAAFTE4Bwmfr2wDkQAAFnBCBczqhgHwiAgKkJVGtUMfOnjaZuFJwDARDwHAJxXe9z29lqCVd1LuS2ZzgBBEAABHQIoKuoAwa7QQAEzEsAwmXeewPPQAAEdAhAuHTAYDcIgIB5CUC4zHtv4BkIgIAOAQiXDhjsBgEQMC8BCJd57w08AwEQ0CEA4dIBg90gAALmJQDhMu+9gWcgAAI6BCBcOmCwGwRAwLwEIFzmvTfwDARAQIcAhEsHDHaDAAiYlwCEy7z3Bp6BAAjoEIBw6YDBbhAAAfMSgHCZ997AMxAAAR0CEC4dMNgNAiBgXgIQLvPeG3gGAiCgQwDCpQMGu0EABMxLAMJl3nsDz0AABHQIQLh0wGA3CICAeQn4Fl7KNq938AwEQAAEHAgUXsoiX19Ltd6X4VAVNkEABECgbgj4WqwsXD4QrrrBjauAAAgYQUA0y9fHz8eIulAHCIAACNQJAdEsTs4jP18ntHEREAABgwgo4TKoLlQDAiAAAnVEAOFWHYHGZUAABIwiIBEXUlxG0UQ9IAACdUQAEVcdgcZlQAAEjCPgKwFXRUW5cTWiJhAAARCoJQKaVqmIq7zwci1dBtWCAAiAgHEElFZxtPX/7To9v4OFa8EAAAAASUVORK5CYII="},983:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png"},6044:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/log_messages-6da2901ac63928daa3dcaf39a78ca9e455482c48d4ba917ee704f697e5210818.png"},1218:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png"},7090:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/targets-6b17daf175185b13bea9eddafd4773e5f41d1ef4e953134f30bee0799c1e5c31.png"},5084:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png"},4834:function(e,t,n){n.d(t,{Z:function(){return a}});let a=n.p+"assets/images/tlm_raw-cc2223b25e8fc732557856168fd7fa04e7b3459bbd163825639fb6235a8e6180.png"},2840:function(e,t,n){n.d(t,{Z:function(){return d},a:function(){return r}});var a=n(2784);let s={},i=a.createContext(s);function r(e){let t=a.useContext(i);return a.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["6868"],{4132:function(e,s,t){t.r(s),t.d(s,{default:()=>h,frontMatter:()=>o,metadata:()=>n,assets:()=>c,toc:()=>l,contentTitle:()=>a});var n=JSON.parse('{"id":"configuration/accessors","title":"Accessors","description":"Responsible for reading and writing data to a buffer","source":"@site/docs/configuration/accessors.md","sourceDirName":"configuration","slug":"/configuration/accessors","permalink":"/tools/staticdocs/docs/configuration/accessors","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/accessors.md","tags":[],"version":"current","sidebarPosition":8,"frontMatter":{"sidebar_position":8,"title":"Accessors","description":"Responsible for reading and writing data to a buffer","sidebar_custom_props":{"myEmoji":"\u270F\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Protocols","permalink":"/tools/staticdocs/docs/configuration/protocols"},"next":{"title":"Tables","permalink":"/tools/staticdocs/docs/configuration/table"}}'),r=t("2322"),i=t("2840");let o={sidebar_position:8,title:"Accessors",description:"Responsible for reading and writing data to a buffer",sidebar_custom_props:{myEmoji:"\u270F\uFE0F"}},a=void 0,c={},l=[{value:"Binary Accessor",id:"binary-accessor",level:3},{value:"Commands",id:"commands",level:4},{value:"Telemetry",id:"telemetry",level:4},{value:"CBOR Accessor",id:"cbor-accessor",level:3},{value:"Commands",id:"commands-1",level:4},{value:"Telemetry",id:"telemetry-1",level:4},{value:"Form Accessor",id:"form-accessor",level:3},{value:"Commands",id:"commands-2",level:4},{value:"Telemetry",id:"telemetry-2",level:4},{value:"HTML Accessor",id:"html-accessor",level:3},{value:"Commands",id:"commands-3",level:4},{value:"Telemetry",id:"telemetry-3",level:4},{value:"HTTP Accessor",id:"http-accessor",level:3},{value:"Commands",id:"commands-4",level:4},{value:"Telemetry",id:"telemetry-4",level:4},{value:"JSON Accessor",id:"json-accessor",level:3},{value:"Commands",id:"commands-5",level:4},{value:"Telemetry",id:"telemetry-5",level:4},{value:"Template Accessor",id:"template-accessor",level:3},{value:"Commands",id:"commands-6",level:4},{value:"Telemetry",id:"telemetry-6",level:4},{value:"XML Accessor",id:"xml-accessor",level:3},{value:"Commands",id:"commands-7",level:4},{value:"Telemetry",id:"telemetry-7",level:4},{value:"GEMS Ascii (Enterprise)",id:"gems-ascii-enterprise",level:3},{value:"Prometheus (Enterprise)",id:"prometheus-enterprise",level:3},{value:"Protocol Buffer (Enterprise)",id:"protocol-buffer-enterprise",level:3}];function d(e){let s={a:"a",code:"code",h3:"h3",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.p,{children:"Accessors are the low level code which know how to read and write data into a buffer. The buffer data then gets written out an interface which uses protocols to potentially change the data before it goes to the target. Accessors handle the different serializations formats such as binary (CCSDS), JSON, CBOR, XML, HTML, Protocol Buffers, etc."}),"\n",(0,r.jsxs)(s.p,{children:["For more information about how Accessors fit with Interfaces and Protocols see ",(0,r.jsx)(s.a,{href:"https://www.openc3.com/news/interoperability-without-standards",children:"Interoperability Without Standards"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"COSMOS provides the following built-in accessors: Binary, CBOR, Form, HTML, HTTP, JSON, Template, XML."}),"\n",(0,r.jsx)(s.p,{children:"COSMOS Enterprise provides the following accessors: GEMS Ascii, Prometheus, Protocol Buffer."}),"\n",(0,r.jsx)(s.h3,{id:"binary-accessor",children:"Binary Accessor"}),"\n",(0,r.jsx)(s.p,{children:"The Binary Accessor serializes data into a binary format when writing to the buffer. This is how many devices expect their data including those following the CCSDS standard. COSMOS handles converting signed and unsigned integers, floats, strings, etc. into their binary representation in the buffer. This includes handling big and little endian, bitfields, and variable length fields. Since binary is so common this is the default Accessor and will be used if no other accessors are given."}),"\n",(0,r.jsx)(s.h4,{id:"commands",children:"Commands"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND INST COLLECT BIG_ENDIAN "Starts a collect"\n  ACCESSOR BinaryAccessor # Typically not explicitly defined because it is the default\n  PARAMETER TYPE       64  16  UINT MIN MAX 0 "Collect type"\n  PARAMETER DURATION   80  32  FLOAT 0.0 10.0 1.0 "Collect duration"\n  PARAMETER OPCODE    112   8  UINT 0x0 0xFF 0xAB "Collect opcode"\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry",children:"Telemetry"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Health and status"\n  ACCESSOR BinaryAccessor # Typically not explicitly defined because it is the default\n  APPEND_ITEM CMD_ACPT_CNT   32 UINT  "Command accept count"\n  APPEND_ITEM COLLECTS       16 UINT  "Number of collects"\n  APPEND_ITEM DURATION       32 FLOAT "Most recent collect duration"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"cbor-accessor",children:"CBOR Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The Concise Binary Object Representation (",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/CBOR",children:"CBOR"}),") Accessor serializes data into a binary format loosely based on JSON. It is a subclass of the JSON Accessor and is what COSMOS uses natively to store log files."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-1",children:"Commands"}),"\n",(0,r.jsxs)(s.p,{children:["Using the CBOR Accessor for ",(0,r.jsx)(s.a,{href:"command",children:"command definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"command#template_file",children:"TEMPLATE_FILE"})," and ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to allow the user to set values in the CBOR data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/JSONPath",children:"JSONPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND CBOR CBORCMD BIG_ENDIAN "CBOR Accessor Command"\n  ACCESSOR CborAccessor\n  TEMPLATE_FILE _cbor_template.bin\n  APPEND_ID_PARAMETER ID_ITEM 32 INT 2 2 2 "Int Item"\n    KEY $.id_item\n  APPEND_PARAMETER ITEM1 16 UINT MIN MAX 101 "Int Item 2"\n    KEY $.item1\n    UNITS CELSIUS C\n  APPEND_PARAMETER ITEM2 16 UINT MIN MAX 12 "Int Item 3"\n    KEY $.more.item2\n    FORMAT_STRING "0x%X"\n  APPEND_PARAMETER ITEM3 64 FLOAT MIN MAX 3.14 "Float Item"\n    KEY $.more.item3\n  APPEND_PARAMETER ITEM4 128 STRING "Example" "String Item"\n    KEY $.more.item4\n  APPEND_ARRAY_PARAMETER ITEM5 8 UINT 0 "Array Item"\n    KEY $.more.item5\n'})}),"\n",(0,r.jsx)(s.p,{children:"Creating the template file requires the use of the Ruby or Python CBOR libraries. Here is an example from Ruby:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'require \'cbor\'\ndata = {"id_item" : 2, "item1" : 101, "more" : { "item2" : 12, "item3" : 3.14, "item4" : "Example", "item5" : [4, 3, 2, 1] } }\nFile.open("_cbor_template.bin", \'wb\') do |file|\n  file.write(data.to_cbor)\nend\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-1",children:"Telemetry"}),"\n",(0,r.jsxs)(s.p,{children:["Using the CBOR Accessor for ",(0,r.jsx)(s.a,{href:"telemetry",children:"telemetry definitions"})," only requires the use of ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to pull values from the CBOR data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/JSONPath",children:"JSONPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY CBOR CBORTLM BIG_ENDIAN "CBOR Accessor Telemetry"\n  ACCESSOR CborAccessor\n  APPEND_ID_ITEM ID_ITEM 32 INT 2 "Int Item"\n    KEY $.id_item\n  APPEND_ITEM ITEM1 16 UINT "Int Item 2"\n    KEY $.item1\n    GENERIC_READ_CONVERSION_START UINT 16\n      value * 2\n    GENERIC_READ_CONVERSION_END\n    UNITS CELSIUS C\n  APPEND_ITEM ITEM2 16 UINT "Int Item 3"\n    KEY $.more.item2\n    FORMAT_STRING "0x%X"\n  APPEND_ITEM ITEM3 64 FLOAT "Float Item"\n    KEY $.more.item3\n  APPEND_ITEM ITEM4 128 STRING "String Item"\n    KEY $.more.item4\n  APPEND_ARRAY_ITEM ITEM5 8 UINT 0 "Array Item"\n    KEY $.more.item5\n'})}),"\n",(0,r.jsx)(s.h3,{id:"form-accessor",children:"Form Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The Form Accessor is typically used with the ",(0,r.jsx)(s.a,{href:"interfaces#http-client-interface",children:"HTTP Client"})," interface to submit forms to a remote HTTP Server."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-2",children:"Commands"}),"\n",(0,r.jsxs)(s.p,{children:["Using the Form Accessor for ",(0,r.jsx)(s.a,{href:"command",children:"command definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to allow the user to set values in the HTTP form. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/XPath",children:"XPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND FORM FORMCMD BIG_ENDIAN "Form Accessor Command"\n  ACCESSOR FormAccessor\n  APPEND_ID_PARAMETER ID_ITEM 32 INT 2 2 2 "Int Item"\n    KEY $.id_item\n  APPEND_PARAMETER ITEM1 16 UINT MIN MAX 101 "Int Item 2"\n    KEY $.item1\n    UNITS CELSIUS C\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-2",children:"Telemetry"}),"\n",(0,r.jsxs)(s.p,{children:["Using the Form Accessor for ",(0,r.jsx)(s.a,{href:"telemetry",children:"telemetry definitions"})," only requires the use of ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to pull values from the HTTP response data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/XPath",children:"XPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY FORM FORMTLM BIG_ENDIAN "Form Accessor Telemetry"\n  ACCESSOR FormAccessor\n  APPEND_ID_ITEM ID_ITEM 32 INT 1 "Int Item"\n    KEY $.id_item\n  APPEND_ITEM ITEM1 16 UINT "Int Item 2"\n    KEY $.item1\n'})}),"\n",(0,r.jsx)(s.h3,{id:"html-accessor",children:"HTML Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The HTML Accessor is typically used with the ",(0,r.jsx)(s.a,{href:"interfaces#http-client-interface",children:"HTTP Client"})," interface to parse a web page."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example see ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-http-get",children:"openc3-cosmos-http-get"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-3",children:"Commands"}),"\n",(0,r.jsx)(s.p,{children:"HTML Accessor is not typically used for commands but it would be similar to Telemetry using XPath Keys."}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-3",children:"Telemetry"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY HTML RESPONSE BIG_ENDIAN "Search results"\n  # Typically you use the HtmlAccessor to parse out the page that is returned\n  # HtmlAccessor is passed to HttpAccessor and used internally\n  ACCESSOR HttpAccessor HtmlAccessor\n  APPEND_ITEM NAME 240 STRING\n    # Keys were located by doing a manual search and then inspecting the page\n    # Right click the text you\'re looking for and then Copy -> Copy XPath\n    KEY normalize-space(//main/div/a[2]/span/h2/text())\n  APPEND_ITEM DESCRIPTION 480 STRING\n    KEY //main/div/a[2]/span/p/text()\n  APPEND_ITEM VERSION 200 STRING\n    KEY //main/div/a[2]/span/h2/span/text()\n  APPEND_ITEM DOWNLOADS 112 STRING\n    KEY normalize-space(//main/div/a[2]/p/text())\n'})}),"\n",(0,r.jsx)(s.h3,{id:"http-accessor",children:"HTTP Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["HTTP Accessor is typically used with the ",(0,r.jsx)(s.a,{href:"interfaces#http-client-interface",children:"HTTP Client"})," or ",(0,r.jsx)(s.a,{href:"interfaces#http-server-interface",children:"HTTP Server"})," interface to parse a web page. It takes another accessor to do the low level reading and writing of the items. The default accessor is FormAccessor. HtlmAccessor, XmlAccessor and JsonAccessor are also common for manipulating HTML, XML and JSON respectively."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example see ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-http-get",children:"openc3-cosmos-http-get"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-4",children:"Commands"}),"\n",(0,r.jsx)(s.p,{children:"When used with the HTTP Client Interface, HTTP Accessor utilizes the following command parameters:"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_PATH"}),(0,r.jsx)(s.td,{children:"requests at this path"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_METHOD"}),(0,r.jsx)(s.td,{children:"request method (GET, POST, DELETE)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_PACKET"}),(0,r.jsx)(s.td,{children:"telemetry packet to store the response"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_ERROR_PACKET"}),(0,r.jsx)(s.td,{children:"telemetry packet to store error responses (status code >= 300)"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_QUERY_XXX"}),(0,r.jsx)(s.td,{children:"sets a value in the params passed to the request (XXX => value, or KEY => value), see example below"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_HEADER_XXX"}),(0,r.jsx)(s.td,{children:"sets a value in the headers passed to the request (XXX => value, or KEY => value), see example below"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"When used with the HTTP Server Interface, HTTP Accessor utilizes the following command parameters:"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_STATUS"}),(0,r.jsx)(s.td,{children:"status to return to clients"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_PATH"}),(0,r.jsx)(s.td,{children:"mount point for server"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_PACKET"}),(0,r.jsx)(s.td,{children:"telemetry packet to store the request"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_HEADER_XXX"}),(0,r.jsx)(s.td,{children:"sets a value in the response headers (XXX => value, or KEY => value), see example below"})]})]})]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND HTML SEARCH BIG_ENDIAN "Searches Rubygems.org"\n  # Note FormAccessor is the default argument for HttpAccessor so it is typically not specified\n  ACCESSOR HttpAccessor\n  PARAMETER HTTP_PATH 0 0 DERIVED nil nil "/search"\n  PARAMETER HTTP_METHOD 0 0 DERIVED nil nil "GET"\n  PARAMETER HTTP_PACKET 0 0 DERIVED nil nil "RESPONSE"\n  PARAMETER HTTP_ERROR_PACKET 0 0 DERIVED nil nil "ERROR"\n  # This sets parameter query=openc3+cosmos\n  # Note the parameter name \'query\' based on HTTP_QUERY_QUERY\n  PARAMETER HTTP_QUERY_QUERY 0 0 DERIVED nil nil "openc3 cosmos"\n    GENERIC_READ_CONVERSION_START\n      value.split.join(\'+\')\n    GENERIC_READ_CONVERSION_END\n  # This sets header Content-Type=text/html\n  # Note that TYPE is not used since the KEY is specified\n  PARAMETER HTTP_HEADER_TYPE 0 0 DERIVED nil nil "text/html"\n    KEY Content-Type\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-4",children:"Telemetry"}),"\n",(0,r.jsx)(s.p,{children:"HTTP Accessor utilizes the following telemetry items:"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_STATUS"}),(0,r.jsx)(s.td,{children:"the request status"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_HEADERS"}),(0,r.jsx)(s.td,{children:"hash of the response headers"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"HTTP_REQUEST"}),(0,r.jsxs)(s.td,{children:["optional hash which returns all the request parameters, see ",(0,r.jsx)(s.a,{href:"interfaces#http-client-interface",children:"HTTP Client Interface"})]})]})]})]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY HTML RESPONSE BIG_ENDIAN "Search results"\n  # Typically you use the HtmlAccessor to parse out the page that is returned\n  ACCESSOR HttpAccessor HtmlAccessor\n  APPEND_ITEM NAME 240 STRING\n    # Keys were located by doing a manual search and then inspecting the page\n    # Right click the text you\'re looking for and then Copy -> Copy XPath\n    KEY normalize-space(//main/div/a[2]/span/h2/text())\n  APPEND_ITEM DESCRIPTION 480 STRING\n    KEY //main/div/a[2]/span/p/text()\n  APPEND_ITEM VERSION 200 STRING\n    KEY //main/div/a[2]/span/h2/span/text()\n  APPEND_ITEM DOWNLOADS 112 STRING\n    KEY normalize-space(//main/div/a[2]/p/text())\n'})}),"\n",(0,r.jsx)(s.h3,{id:"json-accessor",children:"JSON Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The JSON Accessor serializes data into JavaScript Object Notation (",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/JSON",children:"JSON"}),"). JSON is a data interchange format that uses human-readable text to transmit data consisting of key value pairs and arrays."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example see ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-accessor-test",children:"openc3-cosmos-accessor-test"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-5",children:"Commands"}),"\n",(0,r.jsxs)(s.p,{children:["Using the JSON Accessor for ",(0,r.jsx)(s.a,{href:"command",children:"command definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"command#template",children:"TEMPLATE"})," and ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to allow the user to set values in the JSON data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/JSONPath",children:"JSONPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND JSON JSONCMD BIG_ENDIAN "JSON Accessor Command"\n  ACCESSOR JsonAccessor\n  TEMPLATE \'{"id_item":1, "item1":101, "more": { "item2":12, "item3":3.14, "item4":"Example", "item5":[4, 3, 2, 1] } }\'\n  APPEND_ID_PARAMETER ID_ITEM 32 INT 2 2 2 "Int Item"\n    KEY $.id_item\n  APPEND_PARAMETER ITEM1 16 UINT MIN MAX 101 "Int Item 2"\n    KEY $.item1\n    UNITS CELSIUS C\n  APPEND_PARAMETER ITEM2 16 UINT MIN MAX 12 "Int Item 3"\n    KEY $.more.item2\n    FORMAT_STRING "0x%X"\n  APPEND_PARAMETER ITEM3 64 FLOAT MIN MAX 3.14 "Float Item"\n    KEY $.more.item3\n  APPEND_PARAMETER ITEM4 128 STRING "Example" "String Item"\n    KEY $.more.item4\n  APPEND_ARRAY_PARAMETER ITEM5 8 UINT 0 "Array Item"\n    KEY $.more.item5\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-5",children:"Telemetry"}),"\n",(0,r.jsxs)(s.p,{children:["Using the JSON Accessor for ",(0,r.jsx)(s.a,{href:"telemetry",children:"telemetry definitions"})," only requires the use of ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to pull values from the JSON data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/JSONPath",children:"JSONPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY JSON JSONTLM BIG_ENDIAN "JSON Accessor Telemetry"\n  ACCESSOR JsonAccessor\n  APPEND_ID_ITEM ID_ITEM 32 INT 1 "Int Item"\n    KEY $.id_item\n  APPEND_ITEM ITEM1 16 UINT "Int Item 2"\n    KEY $.item1\n    GENERIC_READ_CONVERSION_START UINT 16\n      value * 2\n    GENERIC_READ_CONVERSION_END\n    UNITS CELSIUS C\n  APPEND_ITEM ITEM2 16 UINT "Int Item 3"\n    KEY $.more.item2\n    FORMAT_STRING "0x%X"\n  APPEND_ITEM ITEM3 64 FLOAT "Float Item"\n    KEY $.more.item3\n  APPEND_ITEM ITEM4 128 STRING "String Item"\n    KEY $.more.item4\n  APPEND_ARRAY_ITEM ITEM5 8 UINT 0 "Array Item"\n    KEY $.more.item5\n'})}),"\n",(0,r.jsx)(s.h3,{id:"template-accessor",children:"Template Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The Template Accessor is commonly used with string based command / response protocols such as the ",(0,r.jsx)(s.a,{href:"protocols#cmdresponse-protocol",children:"CmdResponseProtocol"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example see ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-scpi-power-supply",children:"openc3-cosmos-scpi-power-supply"})," in the COSMOS Enterprise Plugins."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-6",children:"Commands"}),"\n",(0,r.jsxs)(s.p,{children:["Using the Template Accessor for ",(0,r.jsx)(s.a,{href:"command",children:"command definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"command#template",children:"TEMPLATE"})," to define a string template with optional parameters that are populated using the command parameters."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'# Some commands don\'t have any parameters and the template is sent as-is\nCOMMAND SCPI_PS RESET BIG_ENDIAN "Reset the power supply state"\n  ACCESSOR TemplateAccessor\n  TEMPLATE "*RST"\n\n# This command has two parameters in the template defined by <XXX>\nCOMMAND SCPI_PS VOLTAGE BIG_ENDIAN "Sets the voltage of a power supply channel"\n  ACCESSOR TemplateAccessor\n  # <VOLTAGE> and <CHANNEL> are replaced by the parameter values\n  TEMPLATE "VOLT <VOLTAGE>, (@<CHANNEL>)"\n  APPEND_PARAMETER VOLTAGE 32 FLOAT MIN MAX 0.0 "Voltage Setting"\n    UNITS VOLTS V\n  APPEND_PARAMETER CHANNEL 8 UINT 1 2 1 "Output Channel"\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-6",children:"Telemetry"}),"\n",(0,r.jsxs)(s.p,{children:["Using the Template Accessor for ",(0,r.jsx)(s.a,{href:"telemetry",children:"telemetry definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"telemetry#template",children:"TEMPLATE"})," to define a template where telemetry values are pulled from the string buffer."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY SCPI_PS STATUS BIG_ENDIAN "Power supply status"\n  ACCESSOR TemplateAccessor\n  # The raw string from the target is something like "1.234,2.345"\n  # String is split by the comma and pushed into MEAS_VOLTAGE_1, MEAS_VOLTAGE_2\n  TEMPLATE "<MEAS_VOLTAGE_1>,<MEAS_VOLTAGE_2>"\n  APPEND_ITEM MEAS_VOLTAGE_1 32 FLOAT "Current Reading for Channel 1"\n  APPEND_ITEM MEAS_VOLTAGE_2 32 FLOAT "Current Reading for Channel 2"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"xml-accessor",children:"XML Accessor"}),"\n",(0,r.jsxs)(s.p,{children:["The XML Accessor is typically used with the ",(0,r.jsx)(s.a,{href:"interfaces#http-client-interface",children:"HTTP Client"})," interface to send and receive XML from a web server."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example see ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-accessor-test",children:"openc3-cosmos-accessor-test"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"commands-7",children:"Commands"}),"\n",(0,r.jsxs)(s.p,{children:["Using the XML Accessor for ",(0,r.jsx)(s.a,{href:"command",children:"command definitions"})," requires the use of ",(0,r.jsx)(s.a,{href:"command#template",children:"TEMPLATE"})," and ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to allow the user to set values in the XML data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/XPath",children:"XPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'COMMAND XML XMLCMD BIG_ENDIAN "XML Accessor Command"\n  ACCESSOR XmlAccessor\n  TEMPLATE \'<html><head><script src="3"><\/script><noscript>101</noscript></head><body><img src="12"/><div><ul><li>3.14</li><li>Example</li></ul></div><div></div></body></html>\'\n  APPEND_ID_PARAMETER ID_ITEM 32 INT 3 3 3 "Int Item"\n    KEY "/html/head/script/@src"\n  APPEND_PARAMETER ITEM1 16 UINT MIN MAX 101 "Int Item 2"\n    KEY "/html/head/noscript/text()"\n    UNITS CELSIUS C\n  APPEND_PARAMETER ITEM2 16 UINT MIN MAX 12 "Int Item 3"\n    KEY "/html/body/img/@src"\n    FORMAT_STRING "0x%X"\n  APPEND_PARAMETER ITEM3 64 FLOAT MIN MAX 3.14 "Float Item"\n    KEY "/html/body/div/ul/li[1]/text()"\n  APPEND_PARAMETER ITEM4 128 STRING "Example" "String Item"\n    KEY "/html/body/div/ul/li[2]/text()"\n'})}),"\n",(0,r.jsx)(s.h4,{id:"telemetry-7",children:"Telemetry"}),"\n",(0,r.jsxs)(s.p,{children:["Using the XML Accessor for ",(0,r.jsx)(s.a,{href:"telemetry",children:"telemetry definitions"})," only requires the use of ",(0,r.jsx)(s.a,{href:"command#key",children:"KEY"})," to pull values from the XML data. Note that the KEY values use ",(0,r.jsx)(s.a,{href:"https://en.wikipedia.org/wiki/XPath",children:"XPath"}),"."]}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TELEMETRY XML XMLTLM BIG_ENDIAN "XML Accessor Telemetry"\n  ACCESSOR XmlAccessor\n  # Template is not required for telemetry, but is useful for simulation\n  TEMPLATE \'<html><head><script src="3"><\/script><noscript>101</noscript></head><body><img src="12"/><div><ul><li>3.14</li><li>Example</li></ul></div><div></div></body></html>\'\n  APPEND_ID_ITEM ID_ITEM 32 INT 3 "Int Item"\n    KEY "/html/head/script/@src"\n  APPEND_ITEM ITEM1 16 UINT "Int Item 2"\n    KEY "/html/head/noscript/text()"\n    GENERIC_READ_CONVERSION_START UINT 16\n      value * 2\n    GENERIC_READ_CONVERSION_END\n    UNITS CELSIUS C\n  APPEND_ITEM ITEM2 16 UINT "Int Item 3"\n    KEY "/html/body/img/@src"\n    FORMAT_STRING "0x%X"\n  APPEND_ITEM ITEM3 64 FLOAT "Float Item"\n    KEY "/html/body/div/ul/li[1]/text()"\n  APPEND_ITEM ITEM4 128 STRING "String Item"\n    KEY "/html/body/div/ul/li[2]/text()"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"gems-ascii-enterprise",children:"GEMS Ascii (Enterprise)"}),"\n",(0,r.jsxs)(s.p,{children:["The GemsAsciiAccessor inherits from ",(0,r.jsx)(s.a,{href:"accessors#template-accessor",children:"TemplateAccessor"}),' to escape the following characters in outgoing commands: "&" => "&a", "|" => "&b", "," => "&c", and ";" => "&d" and reverse them in telemetry. See the ',(0,r.jsx)(s.a,{href:"https://www.omg.org/spec/GEMS/1.3/PDF",children:"GEMS Spec"})," for more information."]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example, please see the ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-gems-interface",children:"openc3-cosmos-gems-interface"})," in the COSMOS Enterprise Plugins."]}),"\n",(0,r.jsx)(s.h3,{id:"prometheus-enterprise",children:"Prometheus (Enterprise)"}),"\n",(0,r.jsx)(s.p,{children:"The PrometheusAccessor is used to read from a Prometheus endpoint and can automatically parse the results into a packet. The PrometheusAccessor is currently only implemented in Ruby."}),"\n",(0,r.jsxs)(s.p,{children:["For a full example, please see the ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-prometheus-metrics",children:"openc3-cosmos-prometheus-metrics"})," in the COSMOS Enterprise Plugins."]}),"\n",(0,r.jsx)(s.h3,{id:"protocol-buffer-enterprise",children:"Protocol Buffer (Enterprise)"}),"\n",(0,r.jsxs)(s.p,{children:["The ProtoAccessor is used to read and write protocol buffers. It is primarily used in conjunction with the ",(0,r.jsx)(s.a,{href:"interfaces#grpc-interface-enterprise",children:"GrpcInterface"}),". The ProtoAccessor is currently only implemented in Ruby."]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Filename"}),(0,r.jsx)(s.td,{children:"File generated by the protocol buffer compiler"}),(0,r.jsx)(s.td,{children:"Yes"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Class"}),(0,r.jsx)(s.td,{children:"Class to use when encoding and decoding the buffer"}),(0,r.jsx)(s.td,{children:"Yes"})]})]})]}),"\n",(0,r.jsxs)(s.p,{children:["For a full example, please see the ",(0,r.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-proto-target",children:"openc3-cosmos-proto-target"})," in the COSMOS Enterprise Plugins."]})]})}function h(e={}){let{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},2840:function(e,s,t){t.d(s,{Z:function(){return a},a:function(){return o}});var n=t(2784);let r={},i=n.createContext(r);function o(e){let s=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]);

data/tools/staticdocs/assets/js/d8ca4191.1861d710.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["8593"],{9931:function(e,t,i){i.r(t),i.d(t,{default:()=>f,frontMatter:()=>a,metadata:()=>n,assets:()=>d,toc:()=>r,contentTitle:()=>l});var n=JSON.parse('{"id":"guides/little-endian-bitfields","title":"Little Endian Bitfields","description":"Defining little endian bitfields","source":"@site/docs/guides/little-endian-bitfields.md","sourceDirName":"guides","slug":"/guides/little-endian-bitfields","permalink":"/tools/staticdocs/docs/guides/little-endian-bitfields","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/little-endian-bitfields.md","tags":[],"version":"current","frontMatter":{"title":"Little Endian Bitfields","description":"Defining little endian bitfields","sidebar_custom_props":{"myEmoji":"\uD83D\uDCBB"}},"sidebar":"defaultSidebar","previous":{"title":"Custom Widgets","permalink":"/tools/staticdocs/docs/guides/custom-widgets"},"next":{"title":"Local Mode","permalink":"/tools/staticdocs/docs/guides/local-mode"}}'),s=i("2322"),o=i("2840");let a={title:"Little Endian Bitfields",description:"Defining little endian bitfields",sidebar_custom_props:{myEmoji:"\uD83D\uDCBB"}},l=void 0,d={},r=[];function c(e){let t={code:"code",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Defining little endian bitfields is a little weird but is possible in COSMOS. However, note that APPEND does not work with little endian bitfields."}),"\n",(0,s.jsx)(t.p,{children:"Here are the rules on how COSMOS handles LITTLE_ENDIAN data:"}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"COSMOS bit offsets are always defined in BIG_ENDIAN terms. Bit 0 is always the most significant bit of the first byte in a packet, and increasing from there."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"All 8, 16, 32, and 64-bit byte-aligned LITTLE_ENDIAN data types define their bit_offset as the most significant bit of the first byte in the packet that contains part of the item. (This is exactly the same as BIG_ENDIAN). Note that for all except 8-bit LITTLE_ENDIAN items, this is the LEAST significant byte of the item."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"LITTLE_ENDIAN bit fields are defined as any LITTLE_ENDIAN INT or UINT item that is not 8, 16, 32, or 64-bit and byte aligned."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"LITTLE_ENDIAN bit fields must define their bit_offset as the location of the most significant bit of the bitfield in BIG_ENDIAN space as described in rule 1 above. So for example. The following C struct at the beginning of a packet would be defined like so:"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-c",children:'struct {\n  unsigned short a:4;\n  unsigned short b:8;\n  unsigned short c:4;\n}\n\nITEM A 4 4 UINT "struct item a"\nITEM B 12 8 UINT "struct item b"\nITEM C 8 4 UINT "struct item c"\n'})}),"\n",(0,s.jsx)(t.p,{children:"This is hard to visualize, but the structure above gets spread out in a byte array like the following after byte swapping: least significant 4 bits of b, 4-bits a, 4-bits c, most significant 4 bits of b."}),"\n",(0,s.jsx)(t.p,{children:"The best advice is to experiment and use the View Raw feature in the Command and Telemetry Service to inspect the bytes of the packet and adjust as necessary."})]})}function f(e={}){let{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},2840:function(e,t,i){i.d(t,{Z:function(){return l},a:function(){return a}});var n=i(2784);let s={},o=n.createContext(s);function a(e){let t=n.useContext(o);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["9148"],{9011:function(e,t,o){o.r(t),o.d(t,{default:()=>h,frontMatter:()=>r,metadata:()=>n,assets:()=>l,toc:()=>c,contentTitle:()=>a});var n=JSON.parse('{"id":"meta/philosophy","title":"Philosophy","description":"COSMOS goals and philosophy","source":"@site/docs/meta/philosophy.md","sourceDirName":"meta","slug":"/meta/philosophy","permalink":"/tools/staticdocs/docs/meta/philosophy","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/meta/philosophy.md","tags":[],"version":"current","frontMatter":{"title":"Philosophy","description":"COSMOS goals and philosophy","sidebar_custom_props":{"myEmoji":"\uD83E\uDD14"}},"sidebar":"defaultSidebar","previous":{"title":"Licenses","permalink":"/tools/staticdocs/docs/meta/licenses"},"next":{"title":"XTCE Support","permalink":"/tools/staticdocs/docs/meta/xtce"}}'),i=o("2322"),s=o("2840");let r={title:"Philosophy",description:"COSMOS goals and philosophy",sidebar_custom_props:{myEmoji:"\uD83E\uDD14"}},a=void 0,l={},c=[];function d(e){let t={li:"li",ol:"ol",p:"p",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"COSMOS is a C3 (Command, Control and Communication) system with the following primary goals:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Interface with Anything"}),"\n",(0,i.jsx)(t.p,{children:"COSMOS should be able to communicate with anything that provides a computer-to-computer interface, regardless of what the interface is. This means that COSMOS adapts to what other systems are doing and evolves over time. It does not publish an API that hardware must adhere to if it wants to communicate with COSMOS."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Log Everything"}),"\n",(0,i.jsx)(t.p,{children:"All data that flows into and out of COSMOS is logged. This provides history as well as attribution for what happened when and why. Keeping accurate logs is an essential and critical aspect of COSMOS."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Open Architecture and Source"}),"\n",(0,i.jsx)(t.p,{children:"Nothing about how COSMOS is implemented is meant to be secret or hidden, even in Enterprise Edition. In all editions, the source code for everything in COSMOS is provided and available for users to inspect or modify as needed. Never worry about an unsolvable problem or having to accept some detail that you don't like. This also opens the world to integrate anything they need into COSMOS without restriction or limitation."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Be Modular"}),"\n",(0,i.jsx)(t.p,{children:"There are infinite number of things for COSMOS to connect to, but it is impossible to ship COSMOS with all the code it would need to talk to everything. For this reason, COSMOS is designed to be modular in all the places that matter."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Use Configuration when Possible, and Code When Logic Is Needed"}),"\n",(0,i.jsx)(t.p,{children:"Configuration is great for making COSMOS as usable as possible by non-software engineers. It also shows where common patterns exist. However, configuration is horrible when logic or custom math are needed."}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:"Empower Developers"}),"\n",(0,i.jsx)(t.p,{children:"COSMOS is meant to be easy enough to be used by everyone, not just C2 software experts."}),"\n"]}),"\n"]})]})}function h(e={}){let{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},2840:function(e,t,o){o.d(t,{Z:function(){return a},a:function(){return r}});var n=o(2784);let i={},s=n.createContext(i);function r(e){let t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js

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

data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["9564"],{1945:function(e,t,n){n.r(t),n.d(t,{default:()=>h,frontMatter:()=>c,metadata:()=>s,assets:()=>r,toc:()=>l,contentTitle:()=>o});var s=JSON.parse('{"id":"tools/admin","title":"Admin","description":"Administer COSMOS, install plugins, change settings","source":"@site/docs/tools/admin.md","sourceDirName":"tools","slug":"/tools/admin","permalink":"/tools/staticdocs/docs/tools/admin","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/admin.md","tags":[],"version":"current","frontMatter":{"title":"Admin","description":"Administer COSMOS, install plugins, change settings","sidebar_custom_props":{"myEmoji":"\uD83D\uDEE0\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Tools","permalink":"/tools/staticdocs/docs/tools"},"next":{"title":"Autonomic (Enterprise)","permalink":"/tools/staticdocs/docs/tools/autonomic"}}'),i=n("2322"),a=n("2840");let c={title:"Admin",description:"Administer COSMOS, install plugins, change settings",sidebar_custom_props:{myEmoji:"\uD83D\uDEE0\uFE0F"}},o=void 0,r={},l=[{value:"Introduction",id:"introduction",level:2},{value:"Plugins",id:"plugins",level:3},{value:"Targets",id:"targets",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Routers",id:"routers",level:3},{value:"Microservices",id:"microservices",level:3},{value:"Packages",id:"packages",level:3},{value:"Tools",id:"tools",level:3},{value:"Redis",id:"redis",level:3},{value:"Secrets",id:"secrets",level:3},{value:"Settings",id:"settings",level:3}];function d(e){let t={a:"a",h2:"h2",h3:"h3",img:"img",p:"p",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(t.p,{children:"Admin has it's own dedicated button at the top of the tools list. It is responsible for administering the COSMOS system including installing new plugins, viewing configuration, storing secrets and changing settings."}),"\n",(0,i.jsx)(t.h3,{id:"plugins",children:"Plugins"}),"\n",(0,i.jsx)(t.p,{children:"The Plugins tab is where you install new plugins into the COSMOS system. Plugins can dynamically add targets, microservices, interfaces, protocols, Telemetry Viewer widgets, and entire tools into the COSMOS runtime. The following screenshot shows the Plugins tab when only the COSMOS Demo is installed:"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Plugins",src:n(8880).Z+"",width:"2200",height:"874"})}),"\n",(0,i.jsx)(t.p,{children:"The plugin gem name is listed along with all the targets it contains. You can Download, Edit, Upgrade, or Delete (uninstall) the plugin using the buttons to the right. If a plugin's target has been modified, the target name turns into a link which when clicked will download the changed files. New plugins are installed by clicking the top field."}),"\n",(0,i.jsx)(t.h3,{id:"targets",children:"Targets"}),"\n",(0,i.jsx)(t.p,{children:"The Targets tab shows all the targets installed and what plugin they came from. Clicking the eyeball shows the raw JSON that makes up the target configuration."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Targets",src:n(2241).Z+"",width:"2200",height:"964"})}),"\n",(0,i.jsx)(t.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,i.jsx)(t.p,{children:"The Interfaces tab shows all the interfaces installed. Clicking the eyeball shows the raw JSON that makes up the interface configuration."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Interfaces",src:n(1932).Z+"",width:"2200",height:"766"})}),"\n",(0,i.jsx)(t.h3,{id:"routers",children:"Routers"}),"\n",(0,i.jsx)(t.p,{children:"The Routers tab shows all the routers installed. Clicking the eyeball shows the raw JSON that makes up the router configuration."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Routers",src:n(3238).Z+"",width:"2200",height:"480"})}),"\n",(0,i.jsx)(t.h3,{id:"microservices",children:"Microservices"}),"\n",(0,i.jsx)(t.p,{children:"The Microservices tab shows all the microservices installed, their update time, state, and count. Clicking the eyeball shows the raw JSON that makes up the microservice configuration."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Microservices",src:n(1844).Z+"",width:"2200",height:"1226"})}),"\n",(0,i.jsx)(t.h3,{id:"packages",children:"Packages"}),"\n",(0,i.jsx)(t.p,{children:"The Packages tab shows all the Ruby gems and Python packages installed in the system. You can also install packages from this tab if you're in an offline (air gapped) environment where COSMOS can't pull dependencies from Rubygems or Pypi."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Packages",src:n(633).Z+"",width:"2200",height:"2620"})}),"\n",(0,i.jsx)(t.h3,{id:"tools",children:"Tools"}),"\n",(0,i.jsx)(t.p,{children:"The Tools tab lists all the tools installed. You can reorder the tools in the Navigation bar by dragging and dropping the left side grab handle."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Tools",src:n(7065).Z+"",width:"2200",height:"2192"})}),"\n",(0,i.jsxs)(t.p,{children:["You can also add links to existing tools in the navigation bar by using the Add button. Any ",(0,i.jsx)(t.a,{href:"https://pictogrammers.com/library/mdi/",children:"material design icons"})," can be used as the Tool icon."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Add Tool",src:n(6387).Z+"",width:"2060",height:"232"})}),"\n",(0,i.jsx)(t.h3,{id:"redis",children:"Redis"}),"\n",(0,i.jsx)(t.p,{children:"The Redis tab allows you to interact directly with the underlying Redis database, making it easy to modify or delete data. THIS IS DANGEROUS, and should only be performed by COSMOS developers."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Redis",src:n(6462).Z+"",width:"2200",height:"1254"})}),"\n",(0,i.jsx)(t.h3,{id:"secrets",children:"Secrets"}),"\n",(0,i.jsxs)(t.p,{children:["The Secrets tab allows you to create secrets that can be used by Interfaces or Microservices using the ",(0,i.jsx)(t.a,{href:"../configuration/plugins#secret",children:"SECRET"})," keyword. Secrets require setting the Secret Name and then can be set to an individual value using the Secret Value, or to the contents of a file (like a certificate file) using the file selector. In the following example the USERNAME and PASSWORD were set to values while CA_FILE was set using an uploaded certificate file."]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Secrets",src:n(6728).Z+"",width:"2200",height:"962"})}),"\n",(0,i.jsx)(t.h3,{id:"settings",children:"Settings"}),"\n",(0,i.jsx)(t.p,{children:"The Settings tab contains various settings used throughout COSMOS. These including clearing saved tool configuration, hiding the Astro Clock, changing the system time zone, adding a top and bottom banner, creating a subtitle in the navigation bar, and changing the URLs of the various package libraries."}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.img,{alt:"Settings1",src:n(7792).Z+"",width:"2200",height:"2172"}),"\n",(0,i.jsx)(t.img,{alt:"Settings2",src:n(4512).Z+"",width:"2200",height:"2436"})]})]})}function h(e={}){let{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},6387:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/add_tool-6919be6e6c05db133a8816a9fc03bf98b0789a8525da4cdaa7b041b25bf9edb8.png"},1932:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/interfaces-fa10646a27eb9045b70c2c485498a864bed1896ff171b7f31f8698288e08ae73.png"},1844:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/microservices-805cc7d137958ac8183579cdb9a9845e7aef79db19723f0773f4ea4d957b48a1.png"},633:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png"},8880:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png"},6462:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/redis-4553b5b35292cca3df1fa08577f2175efef34e0fdfe512f30ca70785b086b24f.png"},3238:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png"},6728:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png"},7792:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png"},4512:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png"},2241:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png"},7065:function(e,t,n){n.d(t,{Z:function(){return s}});let s=n.p+"assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png"},2840:function(e,t,n){n.d(t,{Z:function(){return o},a:function(){return c}});var s=n(2784);let i={},a=s.createContext(i);function c(e){let t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["1029"],{5197:function(e,t,n){n.d(t,{Z:()=>p});var s=n("2322");n("2784");var a=n("7239"),l=n("6460"),i=n("606"),o=n("3422"),r=n("5819"),c=n("6117"),d=n("7720");function u(e){return(0,s.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,s.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}let m="breadcrumbHomeIcon_JFrk";function h(){let e=(0,d.ZP)("/");return(0,s.jsx)("li",{className:"breadcrumbs__item",children:(0,s.jsx)(r.Z,{"aria-label":(0,c.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,s.jsx)(u,{className:m})})})}let b="breadcrumbsContainer_zCmv";function x(e){let{children:t,href:n,isLast:a}=e,l="breadcrumbs__link";return a?(0,s.jsx)("span",{className:l,itemProp:"name",children:t}):n?(0,s.jsx)(r.Z,{className:l,href:n,itemProp:"item",children:(0,s.jsx)("span",{itemProp:"name",children:t})}):(0,s.jsx)("span",{className:l,children:t})}function v(e){let{children:t,active:n,index:l,addMicrodata:i}=e;return(0,s.jsxs)("li",{...i&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},className:(0,a.Z)("breadcrumbs__item",{"breadcrumbs__item--active":n}),children:[t,(0,s.jsx)("meta",{itemProp:"position",content:String(l+1)})]})}function p(){let e=(0,i.s1)(),t=(0,o.Ns)();return e?(0,s.jsx)("nav",{className:(0,a.Z)(l.k.docs.docBreadcrumbs,b),"aria-label":(0,c.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,s.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[t&&(0,s.jsx)(h,{}),e.map((t,n)=>{let a=n===e.length-1,l="category"===t.type&&t.linkUnlisted?void 0:t.href;return(0,s.jsx)(v,{active:a,index:n,addMicrodata:!!l,children:(0,s.jsx)(x,{href:l,isLast:a,children:t.label})},n)})]})}):null}},4148:function(e,t,n){n.r(t),n.d(t,{default:()=>J});var s=n("2322"),a=n("2784"),l=n("254"),i=n("3972");let o=a.createContext(null);function r(e){var t;let{children:n,content:l}=e;let i=(t=l,(0,a.useMemo)(()=>({metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,contentTitle:t.contentTitle,toc:t.toc}),[t]));return(0,s.jsx)(o.Provider,{value:i,children:n})}function c(){let e=(0,a.useContext)(o);if(null===e)throw new i.i6("DocProvider");return e}function d(){let{metadata:e,frontMatter:t,assets:n}=c();return(0,s.jsx)(l.d,{title:e.title,description:e.description,keywords:t.keywords,image:n.image??t.image})}var u=n("7239"),m=n("4755"),h=n("9061");function b(){let{metadata:e}=c();return(0,s.jsx)(h.Z,{previous:e.previous,next:e.next})}var x=n("7997"),v=n("8674"),p=n("6460"),j=n("6117"),g=n("5819");let f={tag:"tag_qE9H",tagRegular:"tagRegular_aHXt",tagWithCount:"tagWithCount_UC8q"};function _(e){let{permalink:t,label:n,count:a,description:l}=e;return(0,s.jsxs)(g.Z,{href:t,title:l,className:(0,u.Z)(f.tag,a?f.tagWithCount:f.tagRegular),children:[n,a&&(0,s.jsx)("span",{children:a})]})}let Z="tags_q74f",C="tag_lSC7";function k(e){let{tags:t}=e;return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("b",{children:(0,s.jsx)(j.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,s.jsx)("ul",{className:(0,u.Z)(Z,"padding--none","margin-left--sm"),children:t.map(e=>(0,s.jsx)("li",{className:C,children:(0,s.jsx)(_,{...e})},e.permalink))})]})}var N=n("7955");function L(){let{metadata:e}=c(),{editUrl:t,lastUpdatedAt:n,lastUpdatedBy:a,tags:l}=e,i=l.length>0,o=!!(t||n||a);return i||o?(0,s.jsxs)("footer",{className:(0,u.Z)(p.k.docs.docFooter,"docusaurus-mt-lg"),children:[i&&(0,s.jsx)("div",{className:(0,u.Z)("row margin-top--sm",p.k.docs.docFooterTagsRow),children:(0,s.jsx)("div",{className:"col",children:(0,s.jsx)(k,{tags:l})})}),o&&(0,s.jsx)(N.Z,{className:(0,u.Z)("margin-top--sm",p.k.docs.docFooterEditMetaRow),editUrl:t,lastUpdatedAt:n,lastUpdatedBy:a})]}):null}var T=n("8859"),w=n("231");let B={tocCollapsibleButton:"tocCollapsibleButton_htYj",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_pAh7"};function I(e){let{collapsed:t,...n}=e;return(0,s.jsx)("button",{type:"button",...n,className:(0,u.Z)("clean-btn",B.tocCollapsibleButton,!t&&B.tocCollapsibleButtonExpanded,n.className),children:(0,s.jsx)(j.Z,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})})}let y={tocCollapsible:"tocCollapsible_O_Qc",tocCollapsibleContent:"tocCollapsibleContent_SlnY",tocCollapsibleExpanded:"tocCollapsibleExpanded_klrc"};function A(e){let{toc:t,className:n,minHeadingLevel:a,maxHeadingLevel:l}=e,{collapsed:i,toggleCollapsed:o}=(0,T.u)({initialState:!0});return(0,s.jsxs)("div",{className:(0,u.Z)(y.tocCollapsible,!i&&y.tocCollapsibleExpanded,n),children:[(0,s.jsx)(I,{collapsed:i,onClick:o}),(0,s.jsx)(T.z,{lazy:!0,className:y.tocCollapsibleContent,collapsed:i,children:(0,s.jsx)(w.Z,{toc:t,minHeadingLevel:a,maxHeadingLevel:l})})]})}let M="tocMobile_tjDr";function E(){let{toc:e,frontMatter:t}=c();return(0,s.jsx)(A,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:(0,u.Z)(p.k.docs.docTocMobile,M)})}var H=n("17");function P(){let{toc:e,frontMatter:t}=c();return(0,s.jsx)(H.Z,{toc:e,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:p.k.docs.docTocDesktop})}var R=n("4126"),V=n("8201");function F(e){let{children:t}=e,n=function(){let{metadata:e,frontMatter:t,contentTitle:n}=c();return!t.hide_title&&void 0===n?e.title:null}();return(0,s.jsxs)("div",{className:(0,u.Z)(p.k.docs.docMarkdown,"markdown"),children:[n&&(0,s.jsx)("header",{children:(0,s.jsx)(R.Z,{as:"h1",children:n})}),(0,s.jsx)(V.Z,{children:t})]})}var S=n("5197"),D=n("5015");let U={docItemContainer:"docItemContainer_Rv5Z",docItemCol:"docItemCol_YAwJ"};function z(e){let{children:t}=e,n=function(){let{frontMatter:e,toc:t}=c(),n=(0,m.i)(),a=e.hide_table_of_contents,l=!a&&t.length>0,i=l?(0,s.jsx)(E,{}):void 0;return{hidden:a,mobile:i,desktop:l&&("desktop"===n||"ssr"===n)?(0,s.jsx)(P,{}):void 0}}(),{metadata:a}=c();return(0,s.jsxs)("div",{className:"row",children:[(0,s.jsxs)("div",{className:(0,u.Z)("col",!n.hidden&&U.docItemCol),children:[(0,s.jsx)(D.Z,{metadata:a}),(0,s.jsx)(x.Z,{}),(0,s.jsxs)("div",{className:U.docItemContainer,children:[(0,s.jsxs)("article",{children:[(0,s.jsx)(S.Z,{}),(0,s.jsx)(v.Z,{}),n.mobile,(0,s.jsx)(F,{children:t}),(0,s.jsx)(L,{})]}),(0,s.jsx)(b,{})]})]}),n.desktop&&(0,s.jsx)("div",{className:"col col--3",children:n.desktop})]})}function J(e){let t=`docs-doc-id-${e.content.metadata.id}`,n=e.content;return(0,s.jsx)(r,{content:e.content,children:(0,s.jsxs)(l.FG,{className:t,children:[(0,s.jsx)(d,{}),(0,s.jsx)(z,{children:(0,s.jsx)(n,{})})]})})}},9061:function(e,t,n){n.d(t,{Z:()=>r});var s=n("2322");n("2784");var a=n("6117"),l=n("7239"),i=n("5819");function o(e){let{permalink:t,title:n,subLabel:a,isNext:o}=e;return(0,s.jsxs)(i.Z,{className:(0,l.Z)("pagination-nav__link",o?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t,children:[a&&(0,s.jsx)("div",{className:"pagination-nav__sublabel",children:a}),(0,s.jsx)("div",{className:"pagination-nav__label",children:n})]})}function r(e){let{previous:t,next:n}=e;return(0,s.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,a.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[t&&(0,s.jsx)(o,{...t,subLabel:(0,s.jsx)(a.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),n&&(0,s.jsx)(o,{...n,subLabel:(0,s.jsx)(a.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}},8674:function(e,t,n){n.d(t,{Z:function(){return r}});var s=n(2322);n(2784);var a=n(7239),l=n(6117),i=n(6460),o=n(8354);function r(e){let{className:t}=e,n=(0,o.E)();return n.badge?(0,s.jsx)("span",{className:(0,a.Z)(t,i.k.docs.docVersionBadge,"badge badge--secondary"),children:(0,s.jsx)(l.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label},children:"Version: {versionLabel}"})}):null}},7997:function(e,t,n){n.d(t,{Z:function(){return v}});var s=n(2322);n(2784);var a=n(7239),l=n(3687),i=n(5819),o=n(6117),r=n(7691),c=n(6460),d=n(2972),u=n(8354);let m={unreleased:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,s.jsx)(o.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:(0,s.jsx)("b",{children:n.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){let{siteTitle:t,versionMetadata:n}=e;return(0,s.jsx)(o.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:(0,s.jsx)("b",{children:n.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function h(e){let t=m[e.versionMetadata.banner];return(0,s.jsx)(t,{...e})}function b(e){let{versionLabel:t,to:n,onClick:a}=e;return(0,s.jsx)(o.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:(0,s.jsx)("b",{children:(0,s.jsx)(i.Z,{to:n,onClick:a,children:(0,s.jsx)(o.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function x(e){let t,{className:n,versionMetadata:i}=e,{siteConfig:{title:o}}=(0,l.Z)(),{pluginId:u}=(0,r.gA)({failfast:!0}),{savePreferredVersionName:m}=(0,d.J)(u),{latestDocSuggestion:x,latestVersionSuggestion:v}=(0,r.Jo)(u);let p=x??(t=v).docs.find(e=>e.id===t.mainDocId);return(0,s.jsxs)("div",{className:(0,a.Z)(n,c.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,s.jsx)("div",{children:(0,s.jsx)(h,{siteTitle:o,versionMetadata:i})}),(0,s.jsx)("div",{className:"margin-top--md",children:(0,s.jsx)(b,{versionLabel:v.label,to:p.path,onClick:()=>m(v.name)})})]})}function v(e){let{className:t}=e,n=(0,u.E)();return n.banner?(0,s.jsx)(x,{className:t,versionMetadata:n}):null}}}]);

data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["3658"],{8509:function(o){o.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Tools","slug":"/tools","permalink":"/tools/staticdocs/docs/tools","sidebar":"defaultSidebar","navigation":{"previous":{"title":"SSL-TLS","permalink":"/tools/staticdocs/docs/configuration/ssl-tls"},"next":{"title":"Admin","permalink":"/tools/staticdocs/docs/tools/admin"}}}}')}}]);

data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["8884"],{5295:function(e,t,i){i.r(t),i.d(t,{default:()=>h,frontMatter:()=>c,metadata:()=>n,assets:()=>d,toc:()=>l,contentTitle:()=>a});var n=JSON.parse('{"id":"guides/local-mode","title":"Local Mode","description":"Edit scripts and screens directly on the host file system","source":"@site/docs/guides/local-mode.md","sourceDirName":"guides","slug":"/guides/local-mode","permalink":"/tools/staticdocs/docs/guides/local-mode","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/local-mode.md","tags":[],"version":"current","frontMatter":{"title":"Local Mode","description":"Edit scripts and screens directly on the host file system","sidebar_custom_props":{"myEmoji":"\uD83E\uDDED"}},"sidebar":"defaultSidebar","previous":{"title":"Little Endian Bitfields","permalink":"/tools/staticdocs/docs/guides/little-endian-bitfields"},"next":{"title":"Logging","permalink":"/tools/staticdocs/docs/guides/logging"}}'),o=i("2322"),s=i("2840");let c={title:"Local Mode",description:"Edit scripts and screens directly on the host file system",sidebar_custom_props:{myEmoji:"\uD83E\uDDED"}},a=void 0,d={},l=[{value:"Using Local Mode",id:"using-local-mode",level:2},{value:"Editing scripts",id:"editing-scripts",level:3},{value:"Disabling Local Mode",id:"disabling-local-mode",level:3},{value:"Configuration Management",id:"configuration-management",level:2}];function r(e){let t={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions."}),"\n",(0,o.jsx)(t.h2,{id:"using-local-mode",children:"Using Local Mode"}),"\n",(0,o.jsxs)(t.p,{children:["In this tutorial we will use the COSMOS Demo as configured by the ",(0,o.jsx)(t.a,{href:"/tools/staticdocs/docs/getting-started/installation",children:"Installation Guide"}),". You should have cloned a ",(0,o.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-project",children:"cosmos-project"})," and started it using ",(0,o.jsx)(t.code,{children:"openc3.sh run"}),"."]}),"\n",(0,o.jsxs)(t.p,{children:["If you check the project directory you should see a ",(0,o.jsx)(t.code,{children:"plugins/DEFAULT/openc3-cosmos-demo"})," directory. This will contain both the gem that was installed and a ",(0,o.jsx)(t.code,{children:"plugin_instance.json"})," file. The ",(0,o.jsx)(t.code,{children:"plugin_instance.json"})," file captures the plugin.txt values when the plugin was installed. Note, all files in the plugins directory are meant to be configuration managed with the project. This ensures if you make local edits and check them in, another user can clone the project and get the exact same configuration. We will demonstrate this later."]}),"\n",(0,o.jsx)(t.h3,{id:"editing-scripts",children:"Editing scripts"}),"\n",(0,o.jsx)(t.admonition,{title:"Visual Studio Code",type:"info",children:(0,o.jsxs)(t.p,{children:["This tutorial will use ",(0,o.jsx)(t.a,{href:"https://code.visualstudio.com",children:"VS Code"})," which is the editor used by the COSMOS developers."]})}),"\n",(0,o.jsxs)(t.p,{children:["The most common use case for Local Mode is script development. Launch Script Runner and open the ",(0,o.jsx)(t.code,{children:"INST/procedures/checks.rb"})," file. If you run this script you'll notice that it has a few errors (by design) which prevent it from running to completion. Let's fix it! Comment out lines 7 & 9 and save the script. You should now notice that Local Mode has saved a copy of the script to ",(0,o.jsx)(t.code,{children:"plugins/targets_modified/INST/procedures/checks.rb"}),"."]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"Project Layout",src:i(4465).Z+"",width:"991",height:"547"})}),"\n",(0,o.jsxs)(t.p,{children:["At this point Local Mode keeps these scripts in sync so we can edit in either place. Let's edit the local script by adding a simple comment at the top: ",(0,o.jsx)(t.code,{children:"# This is a script"}),". Now if we go back to Script Runner the changes have not ",(0,o.jsx)(t.em,{children:"automatically"})," appeared. However, there is a Reload button next to the filename that will refresh the file from the backend."]}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"Project Layout",src:i(2308).Z+"",width:"839",height:"532"})}),"\n",(0,o.jsx)(t.p,{children:"Clicking this reloads the file which has been synced into COSMOS and now we see our comment."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"Project Layout",src:i(9).Z+"",width:"839",height:"232"})}),"\n",(0,o.jsx)(t.h3,{id:"disabling-local-mode",children:"Disabling Local Mode"}),"\n",(0,o.jsxs)(t.p,{children:["If you want to disable Local Mode you can edit the .env file and delete the setting ",(0,o.jsx)(t.code,{children:"OPENC3_LOCAL_MODE=1"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"configuration-management",children:"Configuration Management"}),"\n",(0,o.jsx)(t.p,{children:"It is recommended to configuration manage the entire project including the plugins directory. This will allow any user who starts COSMOS to launch an identical configuration. Plugins are created and updated with any modifications found in the targets_modified directory."}),"\n",(0,o.jsx)(t.p,{children:"At some point you will probably want to release your local changes back to the plugin they originated from. Simply copy the entire targets_modified/TARGET directory back to the original plugin. At that point you can rebuild the plugin using the CLI."}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"openc3-cosmos-demo % ./openc3.sh cli rake build VERSION=1.0.1\n  Successfully built RubyGem\n  Name: openc3-cosmos-demo\n  Version: 1.0.1\n  File: openc3-cosmos-demo-1.0.1.gem\n"})}),"\n",(0,o.jsx)(t.p,{children:"Upgrade the plugin using the Admin Plugins tab and the Upgrade link. When you select your newly built plugin, COSMOS detects the existing changes and asks if you want to delete them. There is a stern warning attached because this will permanently remove these changes! Since we just moved over the changes and rebuilt the plugin we will check the box and INSTALL."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"Project Layout",src:i(3079).Z+"",width:"1272",height:"619"})}),"\n",(0,o.jsxs)(t.p,{children:["When the new plugin is installed, the project's ",(0,o.jsx)(t.code,{children:"plugins"})," directory gets updated with the new plugin and everything under the targets_modified directory is removed because there are no modifications on a new install."]}),"\n",(0,o.jsx)(t.p,{children:"Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS."})]})}function h(e={}){let{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(r,{...e})}):r(e)}},3079:function(e,t,i){i.d(t,{Z:function(){return n}});let n=i.p+"assets/images/delete_modified-ecf9beabf5e6cc6b8cc9d249ba9e313bd18d51c671ebc36029b4cebd729fa2d0.png"},4465:function(e,t,i){i.d(t,{Z:function(){return n}});let n=i.p+"assets/images/project-c521374330008c1292b4da1b9a1c8af6647ab59f1617b470f26e76a521fe8059.png"},2308:function(e,t,i){i.d(t,{Z:function(){return n}});let n=i.p+"assets/images/reload_file-056b240b1d48539a9fecfe2ad1bac0c27d83f5dddcd29af6cf719986869406ee.png"},9:function(e,t,i){i.d(t,{Z:function(){return n}});let n=i.p+"assets/images/reloaded-516bc4c257f9b7f6ce3714f5a06eeef8ad47a8461e21613ba26989d5e56260ec.png"},2840:function(e,t,i){i.d(t,{Z:function(){return a},a:function(){return c}});var n=i(2784);let o={},s=n.createContext(o);function c(e){let t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["8713"],{2664:function(e,s,t){t.r(s),t.d(s,{default:()=>h,frontMatter:()=>i,metadata:()=>n,assets:()=>c,toc:()=>d,contentTitle:()=>a});var n=JSON.parse('{"id":"getting-started/key_concepts","title":"Key Concepts","description":"Projects, Containerization, Frontend, Backend","source":"@site/docs/getting-started/key_concepts.md","sourceDirName":"getting-started","slug":"/getting-started/key_concepts","permalink":"/tools/staticdocs/docs/getting-started/key_concepts","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/key_concepts.md","tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"sidebar_position":5,"title":"Key Concepts","description":"Projects, Containerization, Frontend, Backend","sidebar_custom_props":{"myEmoji":"\uD83D\uDCA1"}},"sidebar":"defaultSidebar","previous":{"title":"Upgrading","permalink":"/tools/staticdocs/docs/getting-started/upgrading"},"next":{"title":"Requirements and Design","permalink":"/tools/staticdocs/docs/getting-started/requirements"}}'),o=t("2322"),r=t("2840");let i={sidebar_position:5,title:"Key Concepts",description:"Projects, Containerization, Frontend, Backend",sidebar_custom_props:{myEmoji:"\uD83D\uDCA1"}},a="OpenC3 COSMOS Key Concepts",c={},d=[{value:"Projects",id:"projects",level:2},{value:"Containerization",id:"containerization",level:2},{value:"Images",id:"images",level:3},{value:"Containers",id:"containers",level:3},{value:"Docker Compose",id:"docker-compose",level:3},{value:"Environment File",id:"environment-file",level:3},{value:"Kubernetes",id:"kubernetes",level:3},{value:"Frontend",id:"frontend",level:2},{value:"Vue.js",id:"vuejs",level:3},{value:"Single-Spa",id:"single-spa",level:3},{value:"Astro UX",id:"astro-ux",level:3},{value:"Backend",id:"backend",level:2},{value:"Redis",id:"redis",level:3},{value:"MinIO",id:"minio",level:3},{value:"Ruby on Rails",id:"ruby-on-rails",level:3}];function l(e){let s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"openc3-cosmos-key-concepts",children:"OpenC3 COSMOS Key Concepts"})}),"\n",(0,o.jsx)(s.h2,{id:"projects",children:"Projects"}),"\n",(0,o.jsxs)(s.p,{children:["The main COSMOS ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos",children:"repo"})," contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project",children:"project"})," to launch COSMOS. The project consists of the ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh",children:"openc3.sh"})," and ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat",children:"openc3.bat"})," files for starting and stopping COSMOS, the ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml",children:"compose.yaml"})," for configuring the COSMOS containers, and the ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/.env",children:".env"})," file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik."]}),"\n",(0,o.jsx)(s.h2,{id:"containerization",children:"Containerization"}),"\n",(0,o.jsx)(s.h3,{id:"images",children:"Images"}),"\n",(0,o.jsxs)(s.p,{children:["Per ",(0,o.jsx)(s.a,{href:"https://docs.docker.com/get-started/overview/#images",children:"Docker"}),', "An image is a read-only template with instructions for creating a Docker container." The base operating system COSMOS uses is called ',(0,o.jsx)(s.a,{href:"https://www.alpinelinux.org/",children:"Alpine Linux"}),". It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a ",(0,o.jsx)(s.a,{href:"https://docs.docker.com/engine/reference/builder/",children:"Dockerfile"})," to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend."]}),"\n",(0,o.jsx)(s.h3,{id:"containers",children:"Containers"}),"\n",(0,o.jsxs)(s.p,{children:["Per ",(0,o.jsx)(s.a,{href:"https://www.docker.com/resources/what-container/",children:"Docker"}),', "a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another." Also per ',(0,o.jsx)(s.a,{href:"https://docs.docker.com/guides/walkthroughs/what-is-a-container/",children:"Docker"}),', "A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system." COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.']}),"\n",(0,o.jsx)(s.p,{children:"The COSMOS Open Source containers consist of the following:"}),"\n",(0,o.jsxs)(s.table,{children:[(0,o.jsx)(s.thead,{children:(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.th,{children:"Name"}),(0,o.jsx)(s.th,{children:"Description"})]})}),(0,o.jsxs)(s.tbody,{children:[(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-cosmos-init-1"}),(0,o.jsx)(s.td,{children:"Copies files to Minio and configures COSMOS then exits"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-operator-1"}),(0,o.jsx)(s.td,{children:"Main COSMOS container that runs the interfaces and target microservices"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-cosmos-cmd-tlm-api-1"}),(0,o.jsx)(s.td,{children:"Rails server that provides all the COSMOS API endpoints"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-cosmos-script-runner-api-1"}),(0,o.jsx)(s.td,{children:"Rails server that provides the Script API endpoints"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-redis-1"}),(0,o.jsx)(s.td,{children:"Serves the static target configuration"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-redis-ephemeral-1"}),(0,o.jsxs)(s.td,{children:["Serves the ",(0,o.jsx)(s.a,{href:"https://redis.io/docs/data-types/streams",children:"streams"})," containing the raw and decomutated data"]})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-minio-1"}),(0,o.jsx)(s.td,{children:"Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-openc3-traefik-1"}),(0,o.jsx)(s.td,{children:"Provides a reverse proxy and load balancer with routes to the COSMOS endpoints"})]})]})]}),"\n",(0,o.jsxs)(s.p,{children:["The container list for ",(0,o.jsx)(s.a,{href:"https://openc3.com/enterprise",children:"Enterprise COSMOS"})," consists of the following:"]}),"\n",(0,o.jsxs)(s.table,{children:[(0,o.jsx)(s.thead,{children:(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.th,{children:"Name"}),(0,o.jsx)(s.th,{children:"Description"})]})}),(0,o.jsxs)(s.tbody,{children:[(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-enterprise-openc3-metrics-1"}),(0,o.jsx)(s.td,{children:"Rails server that provides metrics on COSMOS performance"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-enterprise-openc3-keycloak-1"}),(0,o.jsx)(s.td,{children:"Single-Sign On service for authentication"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"cosmos-enterprise-openc3-postgresql-1"}),(0,o.jsx)(s.td,{children:"SQL Database for use by Keycloak"})]}),(0,o.jsxs)(s.tr,{children:[(0,o.jsx)(s.td,{children:"openc3-nfs *"}),(0,o.jsx)(s.td,{children:"Network File System pod only for use in Kubernetes to share code libraries between containers"})]})]})]}),"\n",(0,o.jsx)(s.h3,{id:"docker-compose",children:"Docker Compose"}),"\n",(0,o.jsxs)(s.p,{children:["Per ",(0,o.jsx)(s.a,{href:"https://docs.docker.com/compose/",children:"Docker"}),', "Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application\'s services. Then, with a single command, you create and start all the services from your configuration." OpenC3 uses compose files to both build and run COSMOS. The ',(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml",children:"compose.yaml"})," is where ports are exposed and environment variables are used."]}),"\n",(0,o.jsx)(s.h3,{id:"environment-file",children:"Environment File"}),"\n",(0,o.jsxs)(s.p,{children:["COSMOS uses an ",(0,o.jsx)(s.a,{href:"https://docs.docker.com/compose/environment-variables/env-file/",children:"environment file"})," along with Docker Compose to pass environment variables into the COSMOS runtime. This ",(0,o.jsx)(s.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/.env",children:".env"})," file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more."]}),"\n",(0,o.jsx)(s.h3,{id:"kubernetes",children:"Kubernetes"}),"\n",(0,o.jsxs)(s.p,{children:["Per ",(0,o.jsx)(s.a,{href:"https://kubernetes.io/",children:"Kubernetes.io"}),', "Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery." ',(0,o.jsx)(s.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," provides ",(0,o.jsx)(s.a,{href:"https://helm.sh/docs/topics/charts/",children:"Helm charts"})," for easy deployment to Kubernetes in various cloud environments."]}),"\n",(0,o.jsxs)(s.p,{children:["COSMOS Enterprise also provides ",(0,o.jsx)(s.a,{href:"https://www.terraform.io/",children:"Terraform"})," scripts to deploy COSMOS infrastructure on various cloud environments."]}),"\n",(0,o.jsx)(s.h2,{id:"frontend",children:"Frontend"}),"\n",(0,o.jsx)(s.h3,{id:"vuejs",children:"Vue.js"}),"\n",(0,o.jsxs)(s.p,{children:["The COSMOS frontend is fully browser native and is implemented in the Vue.js framework. Per ",(0,o.jsx)(s.a,{href:"https://vuejs.org/guide/introduction.html",children:"Vue.js"}),', "Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex." COSMOS utilizes Vue.js and the ',(0,o.jsx)(s.a,{href:"https://vuetifyjs.com/en/",children:"Vuetify"})," Component Framework UI library to build all the COSMOS tools which run in the browser of your choice. COSMOS 5 utilized Vue.js 2.x and Vuetify 2.x while COSMOS 6 utilizes Vue.js 3.x and Vuetify 3.x."]}),"\n",(0,o.jsx)(s.h3,{id:"single-spa",children:"Single-Spa"}),"\n",(0,o.jsxs)(s.p,{children:["While COSMOS itself is written in Vue.js, we utilize a technology called ",(0,o.jsx)(s.a,{href:"https://single-spa.js.org/",children:"single-spa"})," to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelte, and Vue."]}),"\n",(0,o.jsx)(s.h3,{id:"astro-ux",children:"Astro UX"}),"\n",(0,o.jsxs)(s.p,{children:["Per ",(0,o.jsx)(s.a,{href:"https://www.astrouxds.com/",children:"AstroUXDS"}),', "The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices." COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. ',(0,o.jsx)(s.a,{href:"https://www.astrouxds.com/components/clock/",children:"Astro Clock"}),", COSMOS directly incorporates Astro components."]}),"\n",(0,o.jsx)(s.h2,{id:"backend",children:"Backend"}),"\n",(0,o.jsx)(s.h3,{id:"redis",children:"Redis"}),"\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.a,{href:"https://redis.io/",children:"Redis"})," is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our ",(0,o.jsx)(s.a,{href:"/docs/getting-started/key_concepts#containers",children:"container list"})," you'll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into ",(0,o.jsx)(s.a,{href:"https://redis.io/docs/data-types/streams/",children:"Redis streams"}),". The other redis container contains COSMOS configuration that is meant to persist. ",(0,o.jsx)(s.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," provides helm charts that setup ",(0,o.jsx)(s.a,{href:"https://redis.io/docs/management/scaling/",children:"Redis Cluster"})," to perform horizontal scaling where data is shared across multiple Redis nodes."]}),"\n",(0,o.jsx)(s.h3,{id:"minio",children:"MinIO"}),"\n",(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.a,{href:"https://min.io/",children:"MinIO"})," is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. ",(0,o.jsx)(s.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don't need to deploy Tomcat or Nginx for example."]}),"\n",(0,o.jsx)(s.h3,{id:"ruby-on-rails",children:"Ruby on Rails"}),"\n",(0,o.jsxs)(s.p,{children:["The COSMOS API and Script Runner backends are powered by ",(0,o.jsx)(s.a,{href:"https://rubyonrails.org/",children:"Ruby on Rails"}),". Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks."]})]})}function h(e={}){let{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},2840:function(e,s,t){t.d(s,{Z:function(){return a},a:function(){return i}});var n=t(2784);let o={},r=n.createContext(o);function i(e){let s=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]);

data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js

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

data/tools/staticdocs/assets/js/fd886806.fa25adc4.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["4521"],{4310:function(e,t,r){r.d(t,{Z:()=>x});var i=r("2322");r("2784");var c=r("7239"),n=r("5819"),o=r("606"),s=r("7583"),a=r("572"),d=r("6117"),l=r("4126");let u={cardContainer:"cardContainer_S8oU",cardTitle:"cardTitle_HoSo",cardDescription:"cardDescription_c27F"};function h(e){let{href:t,children:r}=e;return(0,i.jsx)(n.Z,{href:t,className:(0,c.Z)("card padding--lg",u.cardContainer),children:r})}function p(e){let{href:t,icon:r,title:n,description:o}=e;return(0,i.jsxs)(h,{href:t,children:[(0,i.jsxs)(l.Z,{as:"h2",className:(0,c.Z)("text--truncate",u.cardTitle),title:n,children:[r," ",n]}),o&&(0,i.jsx)("p",{className:(0,c.Z)("text--truncate",u.cardDescription),title:o,children:o})]})}function f(e){let{item:t}=e,r=(0,o.LM)(t),c=function(){let{selectMessage:e}=(0,s.c)();return t=>e(t,(0,d.I)({message:"1 item|{count} items",id:"theme.docs.DocCard.categoryDescription.plurals",description:"The default description for a category card in the generated index about how many items this category includes"},{count:t}))}();return r?(0,i.jsx)(p,{href:r,icon:"\uD83D\uDDC3\uFE0F",title:t.label,description:t.description??c(t.items.length)}):null}function m(e){let{item:t}=e,r=t?.customProps?.myEmoji??((0,a.Z)(t.href)?"\uD83D\uDCC4\uFE0F":"\uD83D\uDD17"),c=(0,o.xz)(t.docId??void 0);return(0,i.jsx)(p,{href:t.href,icon:r,title:t.label,description:t.description??c?.description})}function x(e){let{item:t}=e;switch(t.type){case"link":return(0,i.jsx)(m,{item:t});case"category":return(0,i.jsx)(f,{item:t});default:throw Error(`unknown item type ${JSON.stringify(t)}`)}}}}]);