RubyGems - openc3-cosmos-tool-docs - Versions diffs - 6.2.1 → 6.3.0 - Mend

openc3-cosmos-tool-docs 6.2.1 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (123) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec4026e0dcc5cfdc96c585b6523a8973a6dcc093306939911f38f67e7dba50e6
-  data.tar.gz: 0d3fcfbafea8e5c013e1925928c89f704bb80ad10324b04fe50c28e9479fad05
+  metadata.gz: ad96c9d6154921577641d9653a59dc24d6f1f6d72cf6f77cd03c907c301e27d6
+  data.tar.gz: 16b83187a79abfc76b2e2c1110946e974bdfc77748547239bd7b0bf7b8f12942
 SHA512:
-  metadata.gz: 871649aa44c49d6f8050f51c6fa21080115ff09990e6b4c599570990d0fb9f3f924c6874176894af5d44bddc2a6f5303665f31e06994e2a375415244f6e6b970
-  data.tar.gz: 88734620c3bf6a4fe677fab07a1f91dfff58b4bed0a18bc7776140d14e11ffa0d8cec89f1000fa6d605b989edde48d3dea1d520efc071f9d6eaf5fc4af33e2db
+  metadata.gz: 2de68003415e058c89c95572b78ca5b3a83e01afd68bcd58438a2b3403e31f8fcf169c83942627eb42645a6b3cd060495ad14c218f212b3d03b9095928d5a632
+  data.tar.gz: 5b5b6fe24a422e968caec6ccb396bca40dd636b2242b222e31c100f7ec3ebe9a0f8290220e5a79659bb667ded4f00101b5553476b281e25b74f2521282a41806

data/tools/staticdocs/404.html CHANGED Viewed

	@@ -1 +1 @@
1	- <!doctype html><html lang=en dir=ltr class="plugin-native plugin-id-default" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Page Not Found \| OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/404.html><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docusaurus_tag content=default><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docsearch:docusaurus_tag content=default><meta data-rh=true property=og:title content="Page Not Found \| OpenC3 Docs"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/404.html><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/404.html hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/404.html hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.~~61a578da~~.js defer></script><script src=/tools/staticdocs/assets/js/main.~~485b7747~~.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()\|\|function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a class="navbar__item navbar__link" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><main class="container margin-vert--xl"><div class=row><div class="col col--6 col--offset-3"><h1 class=hero__title>Page Not Found</h1><p>We could not find what you were looking for.<p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
1	+ <!doctype html><html lang=en dir=ltr class="plugin-native plugin-id-default" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Page Not Found \| OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/404.html><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docusaurus_tag content=default><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docsearch:docusaurus_tag content=default><meta data-rh=true property=og:title content="Page Not Found \| OpenC3 Docs"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/404.html><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/404.html hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/404.html hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.d38c5d36.js defer></script><script src=/tools/staticdocs/assets/js/main.8d947189.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()\|\|function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a class="navbar__item navbar__link" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><main class="container margin-vert--xl"><div class=row><div class="col col--6 col--offset-3"><h1 class=hero__title>Page Not Found</h1><p>We could not find what you were looking for.<p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>

data/tools/staticdocs/assets/images/horizontalbox-085c91cebe26fdd5f85b467556607dd4631da5bccabd84fb164d1f46e45e60c9.png ADDED Viewed

Binary file

data/tools/staticdocs/assets/images/verticalbox-75738427d398302986b52afb373acef11abf3a24f60d20b8cca442688054b22b.png ADDED Viewed

Binary file

data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["5996"],{7015:function(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"link","label":"Introduction","href":"/tools/staticdocs/docs/","docId":"introduction","unlisted":false},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Key Concepts","href":"/tools/staticdocs/docs/getting-started/key-concepts","customProps":{"myEmoji":"\uD83D\uDCA1"},"docId":"getting-started/key-concepts","unlisted":false},{"type":"link","label":"Installation","href":"/tools/staticdocs/docs/getting-started/installation","customProps":{"myEmoji":"\uD83D\uDCBE"},"docId":"getting-started/installation","unlisted":false},{"type":"link","label":"Getting Started","href":"/tools/staticdocs/docs/getting-started/gettingstarted","customProps":{"myEmoji":"\uD83E\uDDD1\u200D\uD83D\uDCBB"},"docId":"getting-started/gettingstarted","unlisted":false},{"type":"link","label":"Upgrading","href":"/tools/staticdocs/docs/getting-started/upgrading","customProps":{"myEmoji":"\u2B06\uFE0F"},"docId":"getting-started/upgrading","unlisted":false},{"type":"link","label":"Command Line Interface","href":"/tools/staticdocs/docs/getting-started/cli","customProps":{"myEmoji":"\u2328\uFE0F"},"docId":"getting-started/cli","unlisted":false},{"type":"link","label":"Code Generators","href":"/tools/staticdocs/docs/getting-started/generators","customProps":{"myEmoji":"\uD83C\uDFED"},"docId":"getting-started/generators","unlisted":false},{"type":"link","label":"Podman","href":"/tools/staticdocs/docs/getting-started/podman","customProps":{"myEmoji":"\uD83E\uDEDB"},"docId":"getting-started/podman","unlisted":false},{"type":"link","label":"Requirements and Design","href":"/tools/staticdocs/docs/getting-started/requirements","customProps":{"myEmoji":"\uD83D\uDCD1"},"docId":"getting-started/requirements","unlisted":false}],"href":"/tools/staticdocs/docs/getting-started"},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"File Format","href":"/tools/staticdocs/docs/configuration/format","docId":"configuration/format","unlisted":false},{"type":"link","label":"Plugins","href":"/tools/staticdocs/docs/configuration/plugins","customProps":{"myEmoji":"\uD83D\uDD0C"},"docId":"configuration/plugins","unlisted":false},{"type":"link","label":"Targets","href":"/tools/staticdocs/docs/configuration/target","customProps":{"myEmoji":"\uD83D\uDEF0\uFE0F"},"docId":"configuration/target","unlisted":false},{"type":"link","label":"Commands","href":"/tools/staticdocs/docs/configuration/command","customProps":{"myEmoji":"\uD83D\uDCE1"},"docId":"configuration/command","unlisted":false},{"type":"link","label":"Telemetry","href":"/tools/staticdocs/docs/configuration/telemetry","customProps":{"myEmoji":"\uD83D\uDCE1"},"docId":"configuration/telemetry","unlisted":false},{"type":"link","label":"Interfaces","href":"/tools/staticdocs/docs/configuration/interfaces","customProps":{"myEmoji":"\uD83D\uDCA1"},"docId":"configuration/interfaces","unlisted":false},{"type":"link","label":"Protocols","href":"/tools/staticdocs/docs/configuration/protocols","customProps":{"myEmoji":"\uD83D\uDCA1"},"docId":"configuration/protocols","unlisted":false},{"type":"link","label":"Accessors","href":"/tools/staticdocs/docs/configuration/accessors","customProps":{"myEmoji":"\u270F\uFE0F"},"docId":"configuration/accessors","unlisted":false},{"type":"link","label":"Tables","href":"/tools/staticdocs/docs/configuration/table","docId":"configuration/table","unlisted":false},{"type":"link","label":"Screens","href":"/tools/staticdocs/docs/configuration/telemetry-screens","customProps":{"myEmoji":"\uD83D\uDDA5\uFE0F"},"docId":"configuration/telemetry-screens","unlisted":false},{"type":"link","label":"SSL-TLS","href":"/tools/staticdocs/docs/configuration/ssl-tls","customProps":{"myEmoji":"\uD83D\uDD10"},"docId":"configuration/ssl-tls","unlisted":false}],"href":"/tools/staticdocs/docs/configuration"},{"type":"category","label":"Tools","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Admin","href":"/tools/staticdocs/docs/tools/admin","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/admin","unlisted":false},{"type":"link","label":"Autonomic (Enterprise)","href":"/tools/staticdocs/docs/tools/autonomic","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/autonomic","unlisted":false},{"type":"link","label":"Bucket Explorer","href":"/tools/staticdocs/docs/tools/bucket-explorer","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/bucket-explorer","unlisted":false},{"type":"link","label":"Calendar (Enterprise)","href":"/tools/staticdocs/docs/tools/calendar","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/calendar","unlisted":false},{"type":"link","label":"Command Sender","href":"/tools/staticdocs/docs/tools/cmd-sender","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/cmd-sender","unlisted":false},{"type":"link","label":"Command and Telemetry Server","href":"/tools/staticdocs/docs/tools/cmd-tlm-server","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/cmd-tlm-server","unlisted":false},{"type":"link","label":"Command History (Enterprise)","href":"/tools/staticdocs/docs/tools/command_history","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/command_history","unlisted":false},{"type":"link","label":"Data Extractor","href":"/tools/staticdocs/docs/tools/data-extractor","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/data-extractor","unlisted":false},{"type":"link","label":"Data Viewer","href":"/tools/staticdocs/docs/tools/data-viewer","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/data-viewer","unlisted":false},{"type":"link","label":"Handbooks","href":"/tools/staticdocs/docs/tools/handbooks","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/handbooks","unlisted":false},{"type":"link","label":"Limits Monitor","href":"/tools/staticdocs/docs/tools/limits-monitor","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/limits-monitor","unlisted":false},{"type":"link","label":"Packet Viewer","href":"/tools/staticdocs/docs/tools/packet-viewer","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/packet-viewer","unlisted":false},{"type":"link","label":"Script Runner","href":"/tools/staticdocs/docs/tools/script-runner","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/script-runner","unlisted":false},{"type":"link","label":"Table Manager","href":"/tools/staticdocs/docs/tools/table-manager","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/table-manager","unlisted":false},{"type":"link","label":"Telemetry Grapher","href":"/tools/staticdocs/docs/tools/tlm-grapher","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/tlm-grapher","unlisted":false},{"type":"link","label":"Telemetry Viewer","href":"/tools/staticdocs/docs/tools/tlm-viewer","customProps":{"myEmoji":"\uD83D\uDEE0\uFE0F"},"docId":"tools/tlm-viewer","unlisted":false}],"href":"/tools/staticdocs/docs/tools"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Bridges","href":"/tools/staticdocs/docs/guides/bridges","customProps":{"myEmoji":"\uD83C\uDF09"},"docId":"guides/bridges","unlisted":false},{"type":"link","label":"COSMOS and NASA cFS","href":"/tools/staticdocs/docs/guides/cfs","customProps":{"myEmoji":"\uD83D\uDE80"},"docId":"guides/cfs","unlisted":false},{"type":"link","label":"Custom Widgets","href":"/tools/staticdocs/docs/guides/custom-widgets","customProps":{"myEmoji":"\uD83D\uDD28"},"docId":"guides/custom-widgets","unlisted":false},{"type":"link","label":"Dynamic Packets","href":"/tools/staticdocs/docs/guides/dynamic-packets","customProps":{"myEmoji":"\uD83E\uDDF1"},"docId":"guides/dynamic-packets","unlisted":false},{"type":"link","label":"Exposing Microservices","href":"/tools/staticdocs/docs/guides/exposing-microservices","customProps":{"myEmoji":"\uD83D\uDEAA"},"docId":"guides/exposing-microservices","unlisted":false},{"type":"link","label":"Little Endian Bitfields","href":"/tools/staticdocs/docs/guides/little-endian-bitfields","customProps":{"myEmoji":"\uD83D\uDCBB"},"docId":"guides/little-endian-bitfields","unlisted":false},{"type":"link","label":"Local Mode","href":"/tools/staticdocs/docs/guides/local-mode","customProps":{"myEmoji":"\uD83E\uDDED"},"docId":"guides/local-mode","unlisted":false},{"type":"link","label":"Logging","href":"/tools/staticdocs/docs/guides/logging","customProps":{"myEmoji":"\uD83E\uDEB5"},"docId":"guides/logging","unlisted":false},{"type":"link","label":"Monitoring","href":"/tools/staticdocs/docs/guides/monitoring","customProps":{"myEmoji":"\uD83D\uDDA5\uFE0F"},"docId":"guides/monitoring","unlisted":false},{"type":"link","label":"Performance","href":"/tools/staticdocs/docs/guides/performance","customProps":{"myEmoji":"\uD83D\uDCCA"},"docId":"guides/performance","unlisted":false},{"type":"link","label":"Raspberry Pi","href":"/tools/staticdocs/docs/guides/raspberrypi","customProps":{"myEmoji":"\uD83C\uDF53"},"docId":"guides/raspberrypi","unlisted":false},{"type":"link","label":"Script Writing Guide","href":"/tools/staticdocs/docs/guides/script-writing","customProps":{"myEmoji":"\uD83C\uDFC3\u200D\u27A1\uFE0F"},"docId":"guides/script-writing","unlisted":false},{"type":"link","label":"Scripting API Guide","href":"/tools/staticdocs/docs/guides/scripting-api","customProps":{"myEmoji":"\uD83D\uDCDD"},"docId":"guides/scripting-api","unlisted":false}],"href":"/tools/staticdocs/docs/guides"},{"type":"category","label":"Development","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Testing with Curl","href":"/tools/staticdocs/docs/development/curl","customProps":{"myEmoji":"\uD83C\uDF0A"},"docId":"development/curl","unlisted":false},{"type":"link","label":"Developing COSMOS","href":"/tools/staticdocs/docs/development/developing","customProps":{"myEmoji":"\uD83D\uDCBB"},"docId":"development/developing","unlisted":false},{"type":"link","label":"JSON API","href":"/tools/staticdocs/docs/development/json-api","customProps":{"myEmoji":"\uD83D\uDDA5\uFE0F"},"docId":"development/json-api","unlisted":false},{"type":"link","label":"Log Structure","href":"/tools/staticdocs/docs/development/log-structure","customProps":{"myEmoji":"\uD83E\uDEB5"},"docId":"development/log-structure","unlisted":false},{"type":"link","label":"Roadmap","href":"/tools/staticdocs/docs/development/roadmap","customProps":{"myEmoji":"\uD83D\uDDFA\uFE0F"},"docId":"development/roadmap","unlisted":false},{"type":"link","label":"Streaming API","href":"/tools/staticdocs/docs/development/streaming-api","customProps":{"myEmoji":"\uD83D\uDCDD"},"docId":"development/streaming-api","unlisted":false},{"type":"link","label":"Testing COSMOS","href":"/tools/staticdocs/docs/development/testing","customProps":{"myEmoji":"\uD83D\uDCCB"},"docId":"development/testing","unlisted":false}],"href":"/tools/staticdocs/docs/development"},{"type":"category","label":"Meta","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Contributing","href":"/tools/staticdocs/docs/meta/contributing","customProps":{"myEmoji":"\uD83D\uDE42"},"docId":"meta/contributing","unlisted":false},{"type":"link","label":"Licenses","href":"/tools/staticdocs/docs/meta/licenses","customProps":{"myEmoji":"\uD83D\uDD75\uFE0F"},"docId":"meta/licenses","unlisted":false},{"type":"link","label":"Philosophy","href":"/tools/staticdocs/docs/meta/philosophy","customProps":{"myEmoji":"\uD83E\uDD14"},"docId":"meta/philosophy","unlisted":false},{"type":"link","label":"XTCE Support","href":"/tools/staticdocs/docs/meta/xtce","customProps":{"myEmoji":"\uD83D\uDE35"},"docId":"meta/xtce","unlisted":false}],"href":"/tools/staticdocs/docs/meta"},{"type":"link","label":"OpenC3, Inc. Privacy Policy","href":"/tools/staticdocs/docs/privacy","docId":"privacy","unlisted":false}]},"docs":{"configuration/accessors":{"id":"configuration/accessors","title":"Accessors","description":"Responsible for reading and writing data to a buffer","sidebar":"defaultSidebar"},"configuration/command":{"id":"configuration/command","title":"Commands","description":"Command definition file format and keywords","sidebar":"defaultSidebar"},"configuration/format":{"id":"configuration/format","title":"File Format","description":"Structure of a COSMOS file, including using ERB","sidebar":"defaultSidebar"},"configuration/interfaces":{"id":"configuration/interfaces","title":"Interfaces","description":"Built-in COSMOS interfaces including how to create one","sidebar":"defaultSidebar"},"configuration/plugins":{"id":"configuration/plugins","title":"Plugins","description":"Plugin definition file format and keywords","sidebar":"defaultSidebar"},"configuration/protocols":{"id":"configuration/protocols","title":"Protocols","description":"Built-in COSMOS protocols including how to create one","sidebar":"defaultSidebar"},"configuration/ssl-tls":{"id":"configuration/ssl-tls","title":"SSL-TLS","description":"How to configure SSL and TLS","sidebar":"defaultSidebar"},"configuration/table":{"id":"configuration/table","title":"Tables","description":"Table definition file format and keywords","sidebar":"defaultSidebar"},"configuration/target":{"id":"configuration/target","title":"Targets","description":"Target definition file format and keywords","sidebar":"defaultSidebar"},"configuration/telemetry":{"id":"configuration/telemetry","title":"Telemetry","description":"Telemetry definition file format and keywords","sidebar":"defaultSidebar"},"configuration/telemetry-screens":{"id":"configuration/telemetry-screens","title":"Screens","description":"Telemetry Viewer screen definition and widget documentation","sidebar":"defaultSidebar"},"development/curl":{"id":"development/curl","title":"Testing with Curl","description":"How to use Curl to hit the COSMOS APIs","sidebar":"defaultSidebar"},"development/developing":{"id":"development/developing","title":"Developing COSMOS","description":"Building COSMOS and developing the frontend and backend","sidebar":"defaultSidebar"},"development/json-api":{"id":"development/json-api","title":"JSON API","description":"Interfacing to the COSMOS APIs using JSON-RPC","sidebar":"defaultSidebar"},"development/log-structure":{"id":"development/log-structure","title":"Log Structure","description":"Structure of the COSMOS log file","sidebar":"defaultSidebar"},"development/roadmap":{"id":"development/roadmap","title":"Roadmap","description":"COSMOS roadmap now and into the future","sidebar":"defaultSidebar"},"development/streaming-api":{"id":"development/streaming-api","title":"Streaming API","description":"Using the websocket streaming API to retrieve data","sidebar":"defaultSidebar"},"development/testing":{"id":"development/testing","title":"Testing COSMOS","description":"Running the Playwright integration tests and unit tests","sidebar":"defaultSidebar"},"getting-started/cli":{"id":"getting-started/cli","title":"Command Line Interface","description":"Using openc3.sh","sidebar":"defaultSidebar"},"getting-started/generators":{"id":"getting-started/generators","title":"Code Generators","description":"Using openc3.sh to generate code","sidebar":"defaultSidebar"},"getting-started/gettingstarted":{"id":"getting-started/gettingstarted","title":"Getting Started","description":"Getting starting with COSMOS","sidebar":"defaultSidebar"},"getting-started/installation":{"id":"getting-started/installation","title":"Installation","description":"Installing OpenC3 COSMOS","sidebar":"defaultSidebar"},"getting-started/key-concepts":{"id":"getting-started/key-concepts","title":"Key Concepts","description":"Projects, Containerization, Frontend, Backend","sidebar":"defaultSidebar"},"getting-started/podman":{"id":"getting-started/podman","title":"Podman","description":"Installing and running COSMOS with Podman","sidebar":"defaultSidebar"},"getting-started/requirements":{"id":"getting-started/requirements","title":"Requirements and Design","description":"COSMOS Requirements and Design","sidebar":"defaultSidebar"},"getting-started/upgrading":{"id":"getting-started/upgrading","title":"Upgrading","description":"How to upgrade and migrate COSMOS","sidebar":"defaultSidebar"},"guides/bridges":{"id":"guides/bridges","title":"Bridges","description":"Bridge data into COSMOS from serial ports, PCI, etc","sidebar":"defaultSidebar"},"guides/cfs":{"id":"guides/cfs","title":"COSMOS and NASA cFS","description":"Tutorial for integrating with NASA cFS","sidebar":"defaultSidebar"},"guides/custom-widgets":{"id":"guides/custom-widgets","title":"Custom Widgets","description":"How to build custom widgets for use in Telemetry Viewer","sidebar":"defaultSidebar"},"guides/dynamic-packets":{"id":"guides/dynamic-packets","title":"Dynamic Packets","description":"How COSMOS dynamically builds packets","sidebar":"defaultSidebar"},"guides/exposing-microservices":{"id":"guides/exposing-microservices","title":"Exposing Microservices","description":"Provide external accessibility to microservices","sidebar":"defaultSidebar"},"guides/little-endian-bitfields":{"id":"guides/little-endian-bitfields","title":"Little Endian Bitfields","description":"Defining little endian bitfields","sidebar":"defaultSidebar"},"guides/local-mode":{"id":"guides/local-mode","title":"Local Mode","description":"Edit scripts and screens directly on the host file system","sidebar":"defaultSidebar"},"guides/logging":{"id":"guides/logging","title":"Logging","description":"The log files in COSMOS","sidebar":"defaultSidebar"},"guides/monitoring":{"id":"guides/monitoring","title":"Monitoring","description":"Various ways to monitor COSMOS internals","sidebar":"defaultSidebar"},"guides/performance":{"id":"guides/performance","title":"Performance","description":"Hardware requirements like memory and CPU","sidebar":"defaultSidebar"},"guides/raspberrypi":{"id":"guides/raspberrypi","title":"Raspberry Pi","description":"Running COSMOS on a Raspberry Pi","sidebar":"defaultSidebar"},"guides/script-writing":{"id":"guides/script-writing","title":"Script Writing Guide","description":"Key concepts and best practices for script writing","sidebar":"defaultSidebar"},"guides/scripting-api":{"id":"guides/scripting-api","title":"Scripting API Guide","description":"Scripting API methods, deprecations and migrations","sidebar":"defaultSidebar"},"introduction":{"id":"introduction","title":"Introduction","description":"This site aims to be a comprehensive guide to OpenC3 COSMOS. We\'ll cover topics such","sidebar":"defaultSidebar"},"meta/contributing":{"id":"meta/contributing","title":"Contributing","description":"Contributing to COSMOS using the github workflow","sidebar":"defaultSidebar"},"meta/licenses":{"id":"meta/licenses","title":"Licenses","description":"COSMOS licenses including the AGPLv3 vs Commercial","sidebar":"defaultSidebar"},"meta/philosophy":{"id":"meta/philosophy","title":"Philosophy","description":"COSMOS goals and philosophy","sidebar":"defaultSidebar"},"meta/xtce":{"id":"meta/xtce","title":"XTCE Support","description":"XTCE Command and Telemetry Definition Standard","sidebar":"defaultSidebar"},"privacy":{"id":"privacy","title":"OpenC3, Inc. Privacy Policy","description":"OpenC3 Inc. is strongly committed to protecting your privacy and complying with your choices. Both personal and non-personal information collected is safeguarded according to the highest privacy and data protection standards adopted worldwide. We have always had a robust and effective data protection program in place which complies with existing law and abides by the data protection principles. However, we recognise our obligations in updating and expanding this program to meet the demands of the GDPR.","sidebar":"defaultSidebar"},"tools/admin":{"id":"tools/admin","title":"Admin","description":"Administer COSMOS, install plugins, change settings","sidebar":"defaultSidebar"},"tools/autonomic":{"id":"tools/autonomic","title":"Autonomic (Enterprise)","description":"Automated execution of commands and scripts","sidebar":"defaultSidebar"},"tools/bucket-explorer":{"id":"tools/bucket-explorer","title":"Bucket Explorer","description":"File browser to the COSMOS backend bucket storage system","sidebar":"defaultSidebar"},"tools/calendar":{"id":"tools/calendar","title":"Calendar (Enterprise)","description":"Calendar visualization of metadata, notes, and timelines","sidebar":"defaultSidebar"},"tools/cmd-sender":{"id":"tools/cmd-sender","title":"Command Sender","description":"Send individual commands","sidebar":"defaultSidebar"},"tools/cmd-tlm-server":{"id":"tools/cmd-tlm-server","title":"Command and Telemetry Server","description":"Status about interfaces, targets and log messages","sidebar":"defaultSidebar"},"tools/command_history":{"id":"tools/command_history","title":"Command History (Enterprise)","description":"See all the commands sent, by whom, and if successful","sidebar":"defaultSidebar"},"tools/data-extractor":{"id":"tools/data-extractor","title":"Data Extractor","description":"Extract command or telemetry data into files","sidebar":"defaultSidebar"},"tools/data-viewer":{"id":"tools/data-viewer","title":"Data Viewer","description":"View packet or item data","sidebar":"defaultSidebar"},"tools/handbooks":{"id":"tools/handbooks","title":"Handbooks","description":"Format the command and telemetry definition into a webpage","sidebar":"defaultSidebar"},"tools/limits-monitor":{"id":"tools/limits-monitor","title":"Limits Monitor","description":"View out of limit items and log messages","sidebar":"defaultSidebar"},"tools/packet-viewer":{"id":"tools/packet-viewer","title":"Packet Viewer","description":"Displays all packets with their items","sidebar":"defaultSidebar"},"tools/script-runner":{"id":"tools/script-runner","title":"Script Runner","description":"Run Python or Ruby scripts to send commands and check telemetry","sidebar":"defaultSidebar"},"tools/table-manager":{"id":"tools/table-manager","title":"Table Manager","description":"Binary file editor with upload / download","sidebar":"defaultSidebar"},"tools/tlm-grapher":{"id":"tools/tlm-grapher","title":"Telemetry Grapher","description":"Graph real time or historical data","sidebar":"defaultSidebar"},"tools/tlm-viewer":{"id":"tools/tlm-viewer","title":"Telemetry Viewer","description":"Build custom screens using built-in widgets","sidebar":"defaultSidebar"}}}}')}}]);

data/tools/staticdocs/assets/js/2bb7bf90.4a658ce6.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["7637"],{2695:function(e,t,n){n.r(t),n.d(t,{default:()=>h,frontMatter:()=>o,metadata:()=>s,assets:()=>l,toc:()=>c,contentTitle:()=>a});var s=JSON.parse('{"id":"getting-started/generators","title":"Code Generators","description":"Using openc3.sh to generate code","source":"@site/docs/getting-started/generators.md","sourceDirName":"getting-started","slug":"/getting-started/generators","permalink":"/tools/staticdocs/docs/getting-started/generators","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/generators.md","tags":[],"version":"current","sidebarPosition":6,"frontMatter":{"sidebar_position":6,"title":"Code Generators","description":"Using openc3.sh to generate code","sidebar_custom_props":{"myEmoji":"\uD83C\uDFED"}},"sidebar":"defaultSidebar","previous":{"title":"Command Line Interface","permalink":"/tools/staticdocs/docs/getting-started/cli"},"next":{"title":"Podman","permalink":"/tools/staticdocs/docs/getting-started/podman"}}'),i=n("2322"),r=n("2840");let o={sidebar_position:6,title:"Code Generators",description:"Using openc3.sh to generate code",sidebar_custom_props:{myEmoji:"\uD83C\uDFED"}},a=void 0,l={},c=[{value:"Plugin Generator",id:"plugin-generator",level:2},{value:"Target Generator",id:"target-generator",level:2},{value:"Microservice Generator",id:"microservice-generator",level:2},{value:"Conversion Generator",id:"conversion-generator",level:2},{value:"Limits Response Generator",id:"limits-response-generator",level:2},{value:"Widget Generator",id:"widget-generator",level:2},{value:"Tool Generator",id:"tool-generator",level:2}];function d(e){let t={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["The COSMOS Code Generators are built into the scripts ",(0,i.jsx)(t.code,{children:"openc3.sh"})," and ",(0,i.jsx)(t.code,{children:"openc3.bat"})," that are included in the COSMOS ",(0,i.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-project",children:"project"})," (more about ",(0,i.jsx)(t.a,{href:"key-concepts#projects",children:"projects"}),")."]}),"\n",(0,i.jsxs)(t.p,{children:["If you followed the ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/getting-started/installation",children:"Installation Guide"})," you should already be inside a cloned ",(0,i.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-project",children:"openc3-project"})," which is in your PATH (necessary for openc3.bat / openc3.sh to be resolved). To see all the available code generators type the following:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"% openc3.sh cli generate\nUnknown generator ''. Valid generators: plugin, target, microservice, widget, conversion,\nlimits_response, tool, tool_vue, tool_angular, tool_react, tool_svelte\n"})}),"\n",(0,i.jsx)(t.admonition,{title:"Training Available",type:"note",children:(0,i.jsxs)(t.p,{children:["If any of this gets confusing, contact us at ",(0,i.jsx)("a",{href:"mailto:support@openc3.com",children:(0,i.jsx)(t.a,{href:"mailto:support@openc3.com",children:"support@openc3.com"})}),". We have training classes available!"]})}),"\n",(0,i.jsx)(t.h2,{id:"plugin-generator",children:"Plugin Generator"}),"\n",(0,i.jsxs)(t.p,{children:["The plugin generator creates the scaffolding for a new COSMOS Plugin. It requires a plugin name and will create a new directory called ",(0,i.jsx)(t.code,{children:"openc3-cosmos-<name>"}),". For example:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"% openc3.sh cli generate plugin\nUsage: cli generate plugin <NAME>\n\n% openc3.sh cli generate plugin GSE\nPlugin openc3-cosmos-gse successfully generated!\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:".gitignore"}),(0,i.jsx)(t.td,{children:"Tells git to ignore any node_modules directory (for tool development)"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"LICENSE.txt"}),(0,i.jsx)(t.td,{children:"License for the plugin. COSMOS Plugins should be licensed in a manner compatible with the AGPLv3, unless they are designed only for use with COSMOS Enterprise Edition."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"openc3-cosmos-gse.gemspec"}),(0,i.jsxs)(t.td,{children:["Gemspec file which should be edited to add user specific information like description, authors, emails, homepage, etc. The name of this file is used in compiling the plugin contents into the final corresponding gem file: e.g. openc3-cosmos-gse-1.0.0.gem. COSMOS plugins should always begin with the openc3-cosmos prefix to make them easily identifiable in the Rubygems repository. The file is formatted as documented at: ",(0,i.jsx)(t.a,{href:"https://guides.rubygems.org/specification-reference/",children:"https://guides.rubygems.org/specification-reference/"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"plugin.txt"}),(0,i.jsxs)(t.td,{children:["COSMOS specific file for Plugin creation. Learn more ",(0,i.jsx)(t.a,{href:"../configuration/plugins",children:"here"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"Rakefile"}),(0,i.jsx)(t.td,{children:'Ruby Rakefile configured to support building the plugin by running "openc3.sh cli rake build VERSION=X.X.X" where X.X.X is the plugin version number'})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"README.md"}),(0,i.jsx)(t.td,{children:"Markdown file used to document the plugin"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"requirements.txt"}),(0,i.jsx)(t.td,{children:"Python dependencies file (only for Python plugins)"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:"While this structure is required, it is not very useful by itself. The plugin generator just creates the framework for other generators to use."}),"\n",(0,i.jsx)(t.h2,{id:"target-generator",children:"Target Generator"}),"\n",(0,i.jsx)(t.p,{children:"The target generator creates the scaffolding for a new COSMOS Target. It must operate inside an existing COSMOS plugin and requires a target name. For example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate target\nUsage: cli generate target <NAME> (--ruby or --python)\n\nopenc3-cosmos-gse % openc3.sh cli generate target GSE\nTarget GSE successfully generated!\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE"}),(0,i.jsx)(t.td,{children:"Contains the configuration for the GSE target. The target name is always defined in all caps. This is typically the default name of the target, but well-designed targets will allow themselves to be renamed at installation."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/cmd_tlm"}),(0,i.jsx)(t.td,{children:"Contains the command and telemetry definition files for the GSE target. These files capture the format of the commands that can be sent to the target, and the telemetry packets that are expected to be received by COSMOS from the target. Note that the files in this folder are processed in alphabetical order by default. That can matter if you reference a packet in another file (it must already have been defined)."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/cmd_tlm/cmd.txt"}),(0,i.jsxs)(t.td,{children:["Example ",(0,i.jsx)(t.a,{href:"../configuration/command",children:"command"})," configuration. Will need to be edited for the target specific commands."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/cmd_tlm/tlm.txt"}),(0,i.jsxs)(t.td,{children:["Example ",(0,i.jsx)(t.a,{href:"../configuration/telemetry",children:"telemetry"})," configuration. Will need to be edited for the target specific telemetry."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/lib"}),(0,i.jsxs)(t.td,{children:["Contains any custom code required by the target. Good examples of custom code are library files, custom ",(0,i.jsx)(t.a,{href:"../configuration/interfaces",children:"interface"})," classes and ",(0,i.jsx)(t.a,{href:"../configuration/protocols",children:"protocols"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/lib/gse.rb/py"}),(0,i.jsx)(t.td,{children:"Example library file which can be expanded as the target is developed. COSMOS recommends building up library methods to avoid code duplication and ease reuse."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/procedures"}),(0,i.jsxs)(t.td,{children:["This folder contains target specific procedures and helper methods which exercise functionality of the target. These procedures should be kept simple and only use the command and telemetry definitions associated with this target. See the ",(0,i.jsx)(t.a,{href:"../guides/script-writing#script-organization",children:"Scripting Guide"})," for more information."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/procedures/procedure.rb/py"}),(0,i.jsx)(t.td,{children:"Procedure with an example of sending a command and checking telemetry"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/public"}),(0,i.jsxs)(t.td,{children:["Put image files here for use in Telemetry Viewer Canvas Image widgets such as ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens#canvasimage",children:"CANVASIMAGE"})," and ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens#canvasimagevalue",children:"CANVASIMAGEVALUE"})]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/screens"}),(0,i.jsxs)(t.td,{children:["Contains telemetry ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens",children:"screens"})," for the target"]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/screens/status.txt"}),(0,i.jsxs)(t.td,{children:["Example ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/telemetry-screens",children:"screen"})," to display telemetry values"]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/target.txt"}),(0,i.jsxs)(t.td,{children:[(0,i.jsx)(t.a,{href:"../configuration/target",children:"Target"})," configuration such as ignoring command and telemetry items and how to process the cmd/tlm files"]})]})]})]}),"\n",(0,i.jsx)(t.p,{children:"It also updates the plugin.txt file to add the new target:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:"VARIABLE gse_target_name GSE\n\nTARGET GSE <%= gse_target_name %>\nINTERFACE <%= gse_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n MAP_TARGET <%= gse_target_name %>\n"})}),"\n",(0,i.jsx)(t.h2,{id:"microservice-generator",children:"Microservice Generator"}),"\n",(0,i.jsx)(t.p,{children:"The microservice generator creates the scaffolding for a new COSMOS Microservice. It must operate inside an existing COSMOS plugin and requires a target name. For example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate microservice\nUsage: cli generate microservice <NAME> (--ruby or --python)\n\nopenc3-cosmos-gse % openc3.sh cli generate microservice background\nMicroservice BACKGROUND successfully generated!\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"microservices/BACKGROUND"}),(0,i.jsx)(t.td,{children:"Contains the code and any necessary configuration for the BACKGROUND microservice. The name is always defined in all caps. This is typically the default name of the microservice, but well-designed microservices will allow themselves to be renamed at installation."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"microservices/BACKGROUND/background.rb"}),(0,i.jsx)(t.td,{children:"Fully functional microservice which will run every minute and log a message. Edit to implement any custom logic that you want to run in the background. Potential uses are safety microservices which can check and autonomously respond to complex events and take action (NOTE: Simple actions might just require a Limits Response)."})]})]})]}),"\n",(0,i.jsx)(t.p,{children:"It also updates the plugin.txt file to add the new microservice:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:"MICROSERVICE BACKGROUND background-microservice\n CMD ruby background.rb\n"})}),"\n",(0,i.jsx)(t.h2,{id:"conversion-generator",children:"Conversion Generator"}),"\n",(0,i.jsxs)(t.p,{children:["The conversion generator creates the scaffolding for a new COSMOS ",(0,i.jsx)(t.a,{href:"../configuration/telemetry#read_conversion",children:"Conversion"}),". It must operate inside an existing COSMOS plugin and requires both a target name and conversion name. For example:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate conversion\nUsage: cli generate conversion <TARGET> <NAME> (--ruby or --python)\n\nopenc3-cosmos-gse % openc3.sh cli generate limits_response GSE double\nConversion targets/GSE/lib/double_conversion.rb successfully generated!\nTo use the conversion add the following to a telemetry item:\n READ_CONVERSION double_conversion.rb\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/lib/double_conversion.rb"}),(0,i.jsx)(t.td,{children:"Fully functional Conversion which has an example implementation of the call() method to convert any existing COSMOS values."})]})})]}),"\n",(0,i.jsx)(t.p,{children:"As the generator states, to use this conversion code you must add it to a telemetry item. For example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:'TELEMETRY GSE STATUS BIG_ENDIAN "Telemetry description"\n # Keyword Name BitSize Type ID Description\n APPEND_ID_ITEM ID 16 INT 1 "Identifier"\n APPEND_ITEM VALUE 32 FLOAT "Value"\n READ_CONVERSION double_conversion.rb\n APPEND_ITEM BOOL 8 UINT "Boolean"\n STATE FALSE 0\n STATE TRUE 1\n APPEND_ITEM LABEL 0 STRING "The label to apply"\n'})}),"\n",(0,i.jsx)(t.h2,{id:"limits-response-generator",children:"Limits Response Generator"}),"\n",(0,i.jsxs)(t.p,{children:["The limits_response generator creates the scaffolding for a new COSMOS ",(0,i.jsx)(t.a,{href:"../configuration/telemetry#limits_response",children:"Limits Response"}),". It must operate inside an existing COSMOS plugin and requires both a target name and limits response name. For example:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate limits_response\nUsage: cli generate limits_response <TARGET> <NAME> (--ruby or --python)\n\nopenc3-cosmos-gse % openc3.sh cli generate limits_response GSE safe\nLimits response targets/GSE/lib/safe_limits_response.rb successfully generated!\nTo use the limits response add the following to a telemetry item:\n LIMITS_RESPONSE safe_limits_response.rb\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"targets/GSE/lib/safe_limits_response.rb"}),(0,i.jsx)(t.td,{children:"Fully functional Limits Response which has an example implementation of the call() method and taking action based on the current limits state of the particular item"})]})})]}),"\n",(0,i.jsx)(t.p,{children:"As the generator states, to use this limits code you must add it to a telemetry item which has limits defined. In the generated GSE target, none of the items have limits defined so you first need to add limits and then add the response."}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:'TELEMETRY GSE STATUS BIG_ENDIAN "Telemetry description"\n # Keyword Name BitSize Type ID Description\n APPEND_ID_ITEM ID 16 INT 1 "Identifier"\n APPEND_ITEM VALUE 32 FLOAT "Value"\n LIMITS DEFAULT 1 ENABLED -80.0 -70.0 60.0 80.0 -20.0 20.0\n LIMITS_RESPONSE safe_limits_response.rb\n APPEND_ITEM BOOL 8 UINT "Boolean"\n STATE FALSE 0\n STATE TRUE 1\n APPEND_ITEM LABEL 0 STRING "The label to apply"\n'})}),"\n",(0,i.jsx)(t.h2,{id:"widget-generator",children:"Widget Generator"}),"\n",(0,i.jsxs)(t.p,{children:["The conversion generator creates the scaffolding for a new COSMOS Widget for use in ",(0,i.jsx)(t.a,{href:"../configuration/telemetry-screens",children:"Telemetry Viewer Screens"}),". For more information see the ",(0,i.jsx)(t.a,{href:"../guides/custom-widgets",children:"Custom Widget"})," guide. It must operate inside an existing COSMOS plugin and requires a widget name. For example:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate widget\nUsage: cli generate widget <SuperdataWidget>\n\nopenc3-cosmos-gse % openc3.sh cli generate widget HelloworldWidget\nWidget HelloworldWidget successfully generated!\nPlease be sure HelloworldWidget does not overlap an existing widget: https://docs.openc3.com/docs/configuration/telemetry-screens\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/HelloworldWidget.vue"}),(0,i.jsx)(t.td,{children:"Fully functional widget which displays a simple value. This can be expanded using existing COSMOS Vue.js code to create any data visualization imaginable."})]})})]}),"\n",(0,i.jsx)(t.p,{children:"It also updates the plugin.txt file to add the new widget:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:"WIDGET Helloworld\n"})}),"\n",(0,i.jsx)(t.h2,{id:"tool-generator",children:"Tool Generator"}),"\n",(0,i.jsxs)(t.p,{children:["The tool generator creates the scaffolding for a new COSMOS Tool. It's It must operate inside an existing COSMOS plugin and requires a tool name. Developing a custom tool requires intensive knowledge of a Javascript framework such as Vue.js, Angular, React, or Svelte. Since all the COSMOS tools are built in Vue.js, that is the recommended framework for new tool development. For additional help on frontend development, see ",(0,i.jsx)(t.a,{href:"../development/developing#running-a-frontend-application",children:"Running a Frontend Application"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"openc3-cosmos-gse % openc3.sh cli generate tool\nUsage: cli generate tool 'Tool Name'\n\nopenc3-cosmos-gse % openc3.sh cli generate widget DataVis\nTool datavis successfully generated!\nPlease be sure datavis does not conflict with any other tools\n"})}),"\n",(0,i.jsx)(t.p,{children:"This creates the following files and directories:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/App.vue"}),(0,i.jsx)(t.td,{children:"Basic Vue template to render the application."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/main.js"}),(0,i.jsx)(t.td,{children:"Entry point for the new tool which loads Vue, Vuetify, and other libraries."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/router.js"}),(0,i.jsx)(t.td,{children:"Vue component router."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/tools/datavis"}),(0,i.jsx)(t.td,{children:"Contains all the files necessary to serve a web-based tool named datavis. The name is always defined in all lowercase. Due to technical limitations, the toolname must be unique and cannot be renamed at installation."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"src/tools/datavis/datavis.vue"}),(0,i.jsx)(t.td,{children:"Fully functional tool which displays a simple button. This can be expanded using existing COSMOS Vue.js code to create any tool imaginable."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"package.json"}),(0,i.jsx)(t.td,{children:"Build and dependency definition file. Used by npm or yarn to build the tool."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"vue.config.js"}),(0,i.jsx)(t.td,{children:"Vue configuration file used to serve the application in development and build the application."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"<dotfiles>"}),(0,i.jsx)(t.td,{children:"Various dotfiles which help configure formatters and tools for Javascript frontend development"})]})]})]}),"\n",(0,i.jsxs)(t.p,{children:["It also updates the plugin.txt file to add the new tool. The icon can be changed to any of the material design icons found ",(0,i.jsx)(t.a,{href:"https://pictogrammers.com/library/mdi/",children:"here"}),"."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:'TOOL datavis "DataVis"\n INLINE_URL main.js\n ICON mdi-file-cad-box\n'})})]})}function h(e={}){let{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},2840:function(e,t,n){n.d(t,{Z:function(){return a},a:function(){return o}});var s=n(2784);let i={},r=s.createContext(i);function o(e){let t=s.useContext(r);return s.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:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/35398c5c.fcf47881.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["8110"],{3332:function(e,t,a){a.r(t),a.d(t,{default:()=>p,frontMatter:()=>c,metadata:()=>n,assets:()=>r,toc:()=>d,contentTitle:()=>o});var n=JSON.parse('{"id":"guides/dynamic-packets","title":"Dynamic Packets","description":"How COSMOS dynamically builds packets","source":"@site/docs/guides/dynamic-packets.md","sourceDirName":"guides","slug":"/guides/dynamic-packets","permalink":"/tools/staticdocs/docs/guides/dynamic-packets","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/dynamic-packets.md","tags":[],"version":"current","frontMatter":{"title":"Dynamic Packets","description":"How COSMOS dynamically builds packets","sidebar_custom_props":{"myEmoji":"\uD83E\uDDF1"}},"sidebar":"defaultSidebar","previous":{"title":"Custom Widgets","permalink":"/tools/staticdocs/docs/guides/custom-widgets"},"next":{"title":"Exposing Microservices","permalink":"/tools/staticdocs/docs/guides/exposing-microservices"}}'),i=a("2322"),s=a("2840");let c={title:"Dynamic Packets",description:"How COSMOS dynamically builds packets",sidebar_custom_props:{myEmoji:"\uD83E\uDDF1"}},o=void 0,r={},d=[{value:"Using Dynamic Update",id:"using-dynamic-update",level:2}];function l(e){let t={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["COSMOS has the ability to dynamically build packets rather than have them statically defined by our ",(0,i.jsx)(t.a,{href:"/docs/configuration/command",children:"COMMAND"})," and ",(0,i.jsx)(t.a,{href:"/docs/configuration/telemetry",children:"TELEMETRY"})," configuration files. This is useful when your telemetry items are dynamic like when generating ",(0,i.jsx)(t.a,{href:"https://prometheus.io/",children:"prometheus"})," metrics."]}),"\n",(0,i.jsxs)(t.p,{children:["The best way to illustrate this capability is with an example. If you're an Enterprise customer, please see the ",(0,i.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-prometheus-metrics",children:"prometheus-metrics"})," plugin."]}),"\n",(0,i.jsx)(t.h2,{id:"using-dynamic-update",children:"Using Dynamic Update"}),"\n",(0,i.jsxs)(t.p,{children:["To use the dynamic update capability in your own code you need to call the ",(0,i.jsx)(t.code,{children:"TargetModel"})," ",(0,i.jsx)(t.code,{children:"dynamic_update"})," method. This method takes an array / list of packets, whether the packets are commands or telemetry, and the filename to create in the config bucket."]}),"\n",(0,i.jsx)(t.p,{children:"Here is the method signature:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:'def dynamic_update(packets, cmd_or_tlm = :TELEMETRY, filename = "dynamic_tlm.txt")\n'})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:'def dynamic_update(self, packets, cmd_or_tlm="TELEMETRY", filename="dynamic_tlm.txt")\n'})}),"\n",(0,i.jsx)(t.p,{children:"Here is an example of using this method:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ruby",children:"# Create a new packet\npacket = Packet.new('INST', 'NEW_PACKET')\n# or get an existing packet\npacket = System.telemetry.packet('INST', 'METRICS')\n# Modify the packet by appending new items to it\npacket.append_item('NEW_ITEM', 32, :FLOAT)\n# Grab the TargetModel associated with the packet's target\ntarget_model = TargetModel.get_model(name: 'INST', scope: 'DEFAULT')\n# Update the target model with the new packet\ntarget_model.dynamic_update([packet])\n"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-python",children:"# Create a new packet\npacket = Packet('INST', 'NEW_PACKET')\n# or get an existing packet\npacket = System.telemetry.packet('INST', 'METRICS')\n# Modify the packet by appending new items to it\npacket.append_item('NEW_ITEM', 32, 'FLOAT')\n# Grab the TargetModel associated with the packet's target\ntarget_model = TargetModel.get_model(name='INST', scope='DEFAULT')\n# Update the target model with the new packet\ntarget_model.dynamic_update([packet])\n"})}),"\n",(0,i.jsx)(t.p,{children:"When this method is called several things happen:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"The COSMOS Redis database is updated with the new packets and the current value table is initialized"}),"\n",(0,i.jsxs)(t.li,{children:["A configuration file for the packets is created and stored at <SCOPE>/targets_modified/<TARGET>/cmd_tlm/dynamic_tlm.txt. Note that if you call ",(0,i.jsx)(t.code,{children:"dynamic_update"})," multiple times you should update the filename so it is not written over."]}),"\n",(0,i.jsx)(t.li,{children:"The COSMOS microservices are informed of the new streaming topics which will contain the raw and decommuted packet data. Part of this action is to restart the microservices so they pickup these changes. For COMMANDS the following are restarted: <SCOPE>__COMMANDLOG__<TARGET> and <SCOPE>__DECOMCMDLOG__<TARGET>. For TELEMETRY the following are restarted: <SCOPE>__PACKET_LOG__<TARGET>, <SCOPE>__DECOMLOG__<TARGET>, and <SCOPE>__DECOM__<TARGET>."}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["Since ",(0,i.jsx)(t.code,{children:"dynamic_update"})," restarts the LOG microservices there is a potential for a loss of packets during the restart. Thus you should not call ",(0,i.jsx)(t.code,{children:"dynamic_update"})," during critical telemetry processing periods."]})]})}function p(e={}){let{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},2840:function(e,t,a){a.d(t,{Z:function(){return o},a:function(){return c}});var n=a(2784);let i={},s=n.createContext(i);function c(e){let t=n.useContext(s);return n.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),n.createElement(s.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js ADDED Viewed

@@ -0,0 +1 @@

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

data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["7258"],{4407:function(e,n,t){t.r(n),t.d(n,{default:()=>h,frontMatter:()=>r,metadata:()=>i,assets:()=>c,toc:()=>d,contentTitle:()=>o});var i=JSON.parse('{"id":"development/streaming-api","title":"Streaming API","description":"Using the websocket streaming API to retrieve data","source":"@site/docs/development/streaming-api.md","sourceDirName":"development","slug":"/development/streaming-api","permalink":"/tools/staticdocs/docs/development/streaming-api","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/streaming-api.md","tags":[],"version":"current","frontMatter":{"title":"Streaming API","description":"Using the websocket streaming API to retrieve data","sidebar_custom_props":{"myEmoji":"\uD83D\uDCDD"}},"sidebar":"defaultSidebar","previous":{"title":"Roadmap","permalink":"/tools/staticdocs/docs/development/roadmap"},"next":{"title":"Testing COSMOS","permalink":"/tools/staticdocs/docs/development/testing"}}'),a=t("2322"),s=t("2840");let r={title:"Streaming API",description:"Using the websocket streaming API to retrieve data",sidebar_custom_props:{myEmoji:"\uD83D\uDCDD"}},o=void 0,c={},d=[{value:"Ruby Example",id:"ruby-example",level:2},{value:"StreamingApi Architecture",id:"streamingapi-architecture",level:2},{value:"Architecture Overview",id:"architecture-overview",level:3},{value:"Key Components",id:"key-components",level:3},{value:"StreamingApi",id:"streamingapi",level:4},{value:"StreamingThread",id:"streamingthread",level:4},{value:"RealtimeStreamingThread",id:"realtimestreamingthread",level:4},{value:"LoggedStreamingThread",id:"loggedstreamingthread",level:4},{value:"StreamingObject",id:"streamingobject",level:4},{value:"StreamingObjectCollection",id:"streamingobjectcollection",level:4},{value:"Data Flow",id:"data-flow",level:3},{value:"Performance Considerations",id:"performance-considerations",level:3},{value:"Security",id:"security",level:3}];function l(e){let n={admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.admonition,{title:"This documentation is for COSMOS Developers",type:"note",children:(0,a.jsx)(n.p,{children:"This information is just generally used behind the scenes in COSMOS tools"})}),"\n",(0,a.jsx)(n.p,{children:"The COSMOS 5 Streaming Api is the primary interface to receive a stream of the telemetry packets and/or command packets that have passed through the COSMOS system, both logged and continuously in realtime. Either raw binary packets or decommutated JSON packets can be requested."}),"\n",(0,a.jsx)(n.p,{children:"This API is implemented over Websockets using the Rails ActionCable framework. Actioncable client libraries are known to exist for at least Javascript, Ruby, and Python. Other languages may exist or could be created. Websockets allow for easy interaction with the new COSMOS 5 Javascript based frontend."}),"\n",(0,a.jsx)(n.p,{children:"The following interactions are all shown in Javascript, but would be very similar in any language.\nConnecting to this API begins by initiating an ActionCable connection."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:"cable = ActionCable.createConsumer('/openc3-api/cable')\n"})}),"\n",(0,a.jsx)(n.p,{children:"This call opens the HTTP connection to the given URL and upgrades it to a websocket connection. This connection can then be shared with multiple \u201Csubscriptions\u201D."}),"\n",(0,a.jsx)(n.p,{children:"A subscription describes a set of data that you want the API to stream to you. Creating a subscription looks like this:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'subscription = cable.subscriptions.create(\n {\n channel: "StreamingChannel",\n scope: "DEFAULT",\n token: token,\n },\n {\n received: (data) => {\n // Handle received data\n },\n connected: () => {\n // First chance to add what you want to stream here\n },\n disconnected: () => {\n // Handle the subscription being disconnected\n },\n rejected: () => {\n // Handle the subscription being rejected\n },\n }\n);\n'})}),"\n",(0,a.jsxs)(n.p,{children:["Subscribing to the StreamingApi requires passing a channel name set to \u201CStreamingChannel\u201D, a scope which is typically \u201CDEFAULT\u201D, and an access token (a password in OpenSource COSMOS). In Javascript you also pass a set of callback functions that run at various lifecycle points in the subscription. The most important of these are ",(0,a.jsx)(n.code,{children:"connected"})," and ",(0,a.jsx)(n.code,{children:"received"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"connected"})," runs when the subscription is accepted by the StreamApi. This callback is the first opportunity to request specific data that you would like streamed. Data can also be added or removed at any time while the subscription is open."]}),"\n",(0,a.jsx)(n.p,{children:"Data can be added to the stream by requesting individual items from a packet or by requesting the entire packet."}),"\n",(0,a.jsx)(n.p,{children:"Adding items to stream is done as follows:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'var items = [\n ["DECOM__TLM__INST__ADCS__Q1__RAW", "0"],\n ["DECOM__CMD__INST__COLLECT__DURATION__WITH_UNITS", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n this.subscription.perform("add", {\n scope: window.openc3Scope,\n token: localStorage.openc3Token,\n items: items,\n start_time: this.startDateTime,\n end_time: this.endDateTime,\n });\n});\n'})}),"\n",(0,a.jsxs)(n.p,{children:["The values in the item name are separated by double underscores, e.g. ",(0,a.jsx)(n.code,{children:"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<ITEM NAME>__<VALUE TYPE>__<REDUCED TYPE>"}),". Mode is either RAW, DECOM, REDUCED_MINUTE, REDUCED_HOUR, or REDUCED_DAY. The next parameter is CMD or TLM followed by the target, packet and item names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS. The last parameter is optional if you want to use the reduced data types. Reduced Type is one of SAMPLE, MIN, MAX, AVG, or STDDEV."]}),"\n",(0,a.jsx)(n.p,{children:"Adding packets to stream is done as follows:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-javascript",children:'var packets = [\n ["RAW__TLM__INST__ADCS", "0"],\n ["DECOM__TLM__INST__HEALTH_STATUS__FORMATTED", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n this.subscription.perform("add", {\n scope: window.openc3Scope,\n token: localStorage.openc3Token,\n packets: packets,\n start_time: this.startDateTime,\n end_time: this.endDateTime,\n });\n});\n'})}),"\n",(0,a.jsxs)(n.p,{children:["The values in the packet name are separated by double underscores, e.g. ",(0,a.jsx)(n.code,{children:"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<VALUE TYPE>"}),". Mode is either RAW or DECOM. The next parameter is CMD or TLM followed by the target and packet names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS."]}),"\n",(0,a.jsx)(n.p,{children:"For Raw mode, VALUE TYPE should be set to RAW or omitted (e.g. TLM__INST__ADCS__RAW or TLM__INST__ADCS).\nstart_time and end_time are standard COSMOS 64-bit integer timestamps in nanoseconds since the Unix Epoch (midnight January 1st, 1970). If start_time is null, that indicates to start streaming from the current time in realtime, indefinitely until items are removed, or the subscription is unsubscribed. end_time is ignored if start_time is null. If start_time is given and end_time is null, that indicates to playback from the given starttime and then continue indefinitely in realtime. If both start_time and end_time are given, then that indicates a temporary playback of historical data."}),"\n",(0,a.jsx)(n.p,{children:"Data returned by the streaming API is handled by the received callback in Javascript. Data is returned as a JSON Array, with a JSON object in the array for each packet returned. Results are batched, and the current implementation will return up to 100 packets in each batch (the array will have 100 entries). 100 packets per batch is not guaranteed, and batches may take on varying sizes based on the size of the data returned, or other factors. An empty array indicates that all data has been sent for a purely historical query and can be used as an end of data indicator."}),"\n",(0,a.jsx)(n.p,{children:"For decommutated items, each packet is represented as a JSON object with a 'time' field holding the COSMOS nanosecond timestamp of the packet, and then each of the requested item keys with their corresponding value from the packet."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'[\n {\n "time": 1234657585858,\n "TLM__INST__ADCS__Q1__RAW": 50.0,\n "TLM__INST__ADCS__Q2__RAW": 100.0\n },\n {\n "time": 1234657585859,\n "TLM__INST__ADCS__Q1__RAW": 60.0,\n "TLM__INST__ADCS__Q2__RAW": 110.0\n }\n]\n'})}),"\n",(0,a.jsx)(n.p,{children:"For raw packets, each packet is represented as a JSON object with a time field holding the COSMOS nanosecond timestamp of the packet, a packet field holding the topic the packet was read from in the form of SCOPE__TELEMETRY__TARGETNAME__PACKETNAME, and a buffer field holding a BASE64 encoded copy of the packet data."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'[\n {\n "time": 1234657585858,\n "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n "buffer": "SkdfjGodkdfjdfoekfsg"\n },\n {\n "time": 1234657585859,\n "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n "buffer": "3i5n49dmnfg9fl32k3"\n }\n]\n'})}),"\n",(0,a.jsx)(n.h2,{id:"ruby-example",children:"Ruby Example"}),"\n",(0,a.jsx)(n.p,{children:"Below is a simple Ruby example for using the streaming API to retrieve telemetry data:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ruby",children:"require 'openc3'\nrequire 'openc3/script/web_socket_api'\n\n$openc3_scope = 'DEFAULT'\nENV['OPENC3_API_HOSTNAME'] = '127.0.0.1'\nENV['OPENC3_API_PORT'] = '2900'\nENV['OPENC3_API_PASSWORD'] = 'password'\n# The following are needed for Enterprise (change user/pass as necessary)\n#ENV['OPENC3_API_USER'] = 'operator'\n#ENV['OPENC3_API_PASSWORD'] = 'operator'\n#ENV['OPENC3_KEYCLOAK_REALM'] = 'openc3'\n#ENV['OPENC3_KEYCLOAK_URL'] = 'http://127.0.0.1:2900/auth'\n\n# Open a file to write CSV data\ncsv = File.open('telemetry_data.csv', 'w')\n\n# Connect to the streaming API\nOpenC3::StreamingWebSocketApi.new() do |api|\n # Add items to stream - request data from yesterday to 1 minute ago\n api.add(items: [\n 'DECOM__TLM__INST__HEALTH_STATUS__TEMP1__CONVERTED',\n 'DECOM__TLM__INST__HEALTH_STATUS__TEMP2__CONVERTED'\n ],\n start_time: (Time.now - 86400).to_nsec_from_epoch, # 24 hours ago\n end_time: (Time.now - 60).to_nsec_from_epoch) # 1 minute ago\n\n # Write CSV header\n csv.puts \"Time,TEMP1,TEMP2\"\n\n # Read all data from the stream\n data = api.read\n\n # Process each data point\n data.each do |item|\n csv.puts \"#{item['__time']/1_000_000_000.0},#{item['DECOM__TLM__INST__HEALTH_STATUS__TEMP1__CONVERTED']},#{item['DECOM__TLM__INST__HEALTH_STATUS__TEMP2__CONVERTED']}\"\n end\nend\ncsv.close()\n"})}),"\n",(0,a.jsx)(n.h2,{id:"streamingapi-architecture",children:"StreamingApi Architecture"}),"\n",(0,a.jsx)(n.p,{children:"The StreamingApi is a core component of COSMOS that provides real-time and historical data streaming capabilities. Below is an overview of its architecture and design."}),"\n",(0,a.jsx)(n.h3,{id:"architecture-overview",children:"Architecture Overview"}),"\n",(0,a.jsx)(n.p,{children:"The StreamingApi uses a modular architecture with several key components:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{children:"StreamingApi\n\u251C\u2500\u2500 StreamingThread (abstract)\n\u2502 \u251C\u2500\u2500 RealtimeStreamingThread\n\u2502 \u2514\u2500\u2500 LoggedStreamingThread\n\u2514\u2500\u2500 StreamingObjectCollection\n \u2514\u2500\u2500 StreamingObject\n"})}),"\n",(0,a.jsx)(n.h3,{id:"key-components",children:"Key Components"}),"\n",(0,a.jsx)(n.h4,{id:"streamingapi",children:"StreamingApi"}),"\n",(0,a.jsx)(n.p,{children:"The main class that manages streaming connections and handles client requests:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Initializes with a client UUID, channel, and scope"}),"\n",(0,a.jsx)(n.li,{children:"Manages thread lifecycle for both real-time and historical data"}),"\n",(0,a.jsx)(n.li,{children:"Processes client requests to add or remove data streams"}),"\n",(0,a.jsx)(n.li,{children:"Coordinates handoff from historical to real-time streaming"}),"\n",(0,a.jsx)(n.li,{children:"Sends batched data back to clients via ActionCable"}),"\n"]}),"\n",(0,a.jsx)(n.h4,{id:"streamingthread",children:"StreamingThread"}),"\n",(0,a.jsx)(n.p,{children:"Abstract base class that defines common thread functionality:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Manages thread lifecycle (start, stop)"}),"\n",(0,a.jsx)(n.li,{children:"Processes data from various sources"}),"\n",(0,a.jsx)(n.li,{children:"Handles batching and transmission of results"}),"\n",(0,a.jsx)(n.li,{children:"Determines when streaming is complete"}),"\n"]}),"\n",(0,a.jsx)(n.h4,{id:"realtimestreamingthread",children:"RealtimeStreamingThread"}),"\n",(0,a.jsx)(n.p,{children:"Specialized thread for real-time data:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Subscribes to Redis topics"}),"\n",(0,a.jsx)(n.li,{children:"Processes incoming messages in real-time"}),"\n",(0,a.jsx)(n.li,{children:"Continuous streaming from current time"}),"\n"]}),"\n",(0,a.jsx)(n.h4,{id:"loggedstreamingthread",children:"LoggedStreamingThread"}),"\n",(0,a.jsx)(n.p,{children:"Specialized thread for historical data:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Reads from archived log files"}),"\n",(0,a.jsx)(n.li,{children:"Handles time-based sorting of data"}),"\n",(0,a.jsx)(n.li,{children:"Transitions to real-time streaming when historical data is exhausted"}),"\n"]}),"\n",(0,a.jsx)(n.h4,{id:"streamingobject",children:"StreamingObject"}),"\n",(0,a.jsx)(n.p,{children:"Represents a single subscription item:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Parses and validates stream keys"}),"\n",(0,a.jsx)(n.li,{children:"Stores metadata about the stream (mode, target, packet, item)"}),"\n",(0,a.jsx)(n.li,{children:"Tracks timestamps and offsets"}),"\n",(0,a.jsx)(n.li,{children:"Handles authorization"}),"\n"]}),"\n",(0,a.jsx)(n.h4,{id:"streamingobjectcollection",children:"StreamingObjectCollection"}),"\n",(0,a.jsx)(n.p,{children:"Manages groups of StreamingObjects:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Organizes objects by topic"}),"\n",(0,a.jsx)(n.li,{children:"Tracks collective state"}),"\n",(0,a.jsx)(n.li,{children:"Provides efficient lookups"}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"data-flow",children:"Data Flow"}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsx)(n.li,{children:"Client connects to ActionCable and subscribes to StreamingChannel"}),"\n",(0,a.jsx)(n.li,{children:"Client sends 'add' request with items/packets to stream"}),"\n",(0,a.jsx)(n.li,{children:"StreamingApi creates appropriate StreamingObjects with authorization"}),"\n",(0,a.jsxs)(n.li,{children:["For historical requests:","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"LoggedStreamingThread reads from log files"}),"\n",(0,a.jsx)(n.li,{children:"Data is sent in batches to client"}),"\n",(0,a.jsx)(n.li,{children:"When historical data is exhausted, handoff to real-time"}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["For real-time requests:","\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"RealtimeStreamingThread subscribes to Redis topics"}),"\n",(0,a.jsx)(n.li,{children:"Data is sent to client as it arrives"}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.li,{children:"Client can add/remove items at any time"}),"\n",(0,a.jsx)(n.li,{children:"When client disconnects, all threads are terminated"}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"performance-considerations",children:"Performance Considerations"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Uses thread-per-request model for historical data"}),"\n",(0,a.jsx)(n.li,{children:"Maintains a single thread for real-time data"}),"\n",(0,a.jsx)(n.li,{children:"Batches results to reduce network overhead (up to 100 items per batch)"}),"\n",(0,a.jsx)(n.li,{children:"File caching for efficient historical data access"}),"\n",(0,a.jsx)(n.li,{children:"Seamless transition from historical to real-time data"}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"security",children:"Security"}),"\n",(0,a.jsx)(n.p,{children:"Every StreamingObject verifies authorization for the specific target and packet being requested, ensuring users only access data they have permission to view."})]})}function h(e={}){let{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},2840:function(e,n,t){t.d(n,{Z:function(){return o},a:function(){return r}});var i=t(2784);let a={},s=i.createContext(a);function r(e){let n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/6b210247.6a77064a.js ADDED Viewed

@@ -0,0 +1 @@

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

data/tools/staticdocs/assets/js/6f92e431.6439052e.js ADDED Viewed

@@ -0,0 +1 @@

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

data/tools/staticdocs/assets/js/75e64983.324643a8.js ADDED Viewed

@@ -0,0 +1 @@

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

data/tools/staticdocs/assets/js/{7f5b2696.72e3b019.js → 7f5b2696.a3dc640e.js} RENAMED Viewed

	@@ -1 +1 @@
1	- "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com\|\|[]).push([["2434"],{6562:function(t){t.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Getting Started","description":"Get started with OpenC3 COSMOS","slug":"/getting-started","permalink":"/tools/staticdocs/docs/getting-started","sidebar":"defaultSidebar","navigation":{"previous":{"title":"Introduction","permalink":"/tools/staticdocs/docs/"},"next":{"title":"~~Installation~~","permalink":"/tools/staticdocs/docs/getting-started/~~installation~~"}}}}')}}]);
1	+ "use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com\|\|[]).push([["2434"],{6562:function(t){t.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Getting Started","description":"Get started with OpenC3 COSMOS","slug":"/getting-started","permalink":"/tools/staticdocs/docs/getting-started","sidebar":"defaultSidebar","navigation":{"previous":{"title":"Introduction","permalink":"/tools/staticdocs/docs/"},"next":{"title":"Key Concepts","permalink":"/tools/staticdocs/docs/getting-started/key-concepts"}}}}')}}]);