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.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +1 -1
- data/tools/staticdocs/assets/images/horizontalbox-085c91cebe26fdd5f85b467556607dd4631da5bccabd84fb164d1f46e45e60c9.png +0 -0
- data/tools/staticdocs/assets/images/verticalbox-75738427d398302986b52afb373acef11abf3a24f60d20b8cca442688054b22b.png +0 -0
- data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.4a658ce6.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.fcf47881.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.6a77064a.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.6439052e.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.324643a8.js +1 -0
- data/tools/staticdocs/assets/js/{7f5b2696.72e3b019.js → 7f5b2696.a3dc640e.js} +1 -1
- data/tools/staticdocs/assets/js/{9424f0b3.96e6dac4.js → 9424f0b3.3683501c.js} +1 -1
- data/tools/staticdocs/assets/js/964eb012.dbc2c206.js +1 -0
- data/tools/staticdocs/assets/js/97535711.e595488c.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.841b4a2e.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.b418f772.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.e01c9bb4.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.3aad95fc.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.535a2ceb.js +1 -0
- data/tools/staticdocs/assets/js/ce89ef36.6b89b0fe.js +1 -0
- data/tools/staticdocs/assets/js/{d8ca4191.f5da7c6d.js → d8ca4191.8df86c99.js} +1 -1
- data/tools/staticdocs/assets/js/db8fa1d0.f1eed806.js +1 -0
- data/tools/staticdocs/assets/js/{main.485b7747.js → main.8d947189.js} +2 -2
- data/tools/staticdocs/assets/js/runtime~main.d38c5d36.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +1 -1
- data/tools/staticdocs/docs/configuration/command.html +1 -1
- data/tools/staticdocs/docs/configuration/format.html +1 -1
- data/tools/staticdocs/docs/configuration/interfaces.html +1 -1
- data/tools/staticdocs/docs/configuration/plugins.html +1 -1
- data/tools/staticdocs/docs/configuration/protocols.html +1 -1
- data/tools/staticdocs/docs/configuration/ssl-tls.html +1 -1
- data/tools/staticdocs/docs/configuration/table.html +1 -1
- data/tools/staticdocs/docs/configuration/target.html +1 -1
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +5 -5
- data/tools/staticdocs/docs/configuration/telemetry.html +1 -1
- data/tools/staticdocs/docs/configuration.html +1 -1
- data/tools/staticdocs/docs/development/curl.html +1 -1
- data/tools/staticdocs/docs/development/developing.html +1 -1
- data/tools/staticdocs/docs/development/json-api.html +1 -1
- data/tools/staticdocs/docs/development/log-structure.html +1 -1
- data/tools/staticdocs/docs/development/roadmap.html +20 -29
- data/tools/staticdocs/docs/development/streaming-api.html +88 -2
- data/tools/staticdocs/docs/development/testing.html +5 -2
- data/tools/staticdocs/docs/development.html +1 -1
- data/tools/staticdocs/docs/getting-started/cli.html +47 -0
- data/tools/staticdocs/docs/getting-started/generators.html +2 -2
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +2 -2
- data/tools/staticdocs/docs/getting-started/installation.html +3 -3
- data/tools/staticdocs/docs/getting-started/{key_concepts.html → key-concepts.html} +3 -3
- data/tools/staticdocs/docs/getting-started/podman.html +2 -2
- data/tools/staticdocs/docs/getting-started/requirements.html +2 -2
- data/tools/staticdocs/docs/getting-started/upgrading.html +3 -3
- data/tools/staticdocs/docs/getting-started.html +1 -1
- data/tools/staticdocs/docs/guides/bridges.html +1 -1
- data/tools/staticdocs/docs/guides/cfs.html +1 -1
- data/tools/staticdocs/docs/guides/custom-widgets.html +2 -2
- data/tools/staticdocs/docs/guides/dynamic-packets.html +17 -0
- data/tools/staticdocs/docs/guides/{exposing_microservices.html → exposing-microservices.html} +2 -2
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +2 -2
- data/tools/staticdocs/docs/guides/local-mode.html +1 -1
- data/tools/staticdocs/docs/guides/logging.html +1 -1
- data/tools/staticdocs/docs/guides/monitoring.html +1 -1
- data/tools/staticdocs/docs/guides/performance.html +1 -1
- data/tools/staticdocs/docs/guides/raspberrypi.html +1 -1
- data/tools/staticdocs/docs/guides/script-writing.html +1 -1
- data/tools/staticdocs/docs/guides/scripting-api.html +33 -3
- data/tools/staticdocs/docs/guides.html +1 -1
- data/tools/staticdocs/docs/meta/contributing.html +1 -1
- data/tools/staticdocs/docs/meta/licenses.html +1 -1
- data/tools/staticdocs/docs/meta/philosophy.html +1 -1
- data/tools/staticdocs/docs/meta/xtce.html +1 -1
- data/tools/staticdocs/docs/meta.html +1 -1
- data/tools/staticdocs/docs/privacy.html +1 -1
- data/tools/staticdocs/docs/tools/admin.html +1 -1
- data/tools/staticdocs/docs/tools/autonomic.html +1 -1
- data/tools/staticdocs/docs/tools/bucket-explorer.html +1 -1
- data/tools/staticdocs/docs/tools/calendar.html +1 -1
- data/tools/staticdocs/docs/tools/cmd-sender.html +1 -1
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +1 -1
- data/tools/staticdocs/docs/tools/command_history.html +1 -1
- data/tools/staticdocs/docs/tools/data-extractor.html +1 -1
- data/tools/staticdocs/docs/tools/data-viewer.html +1 -1
- data/tools/staticdocs/docs/tools/handbooks.html +1 -1
- data/tools/staticdocs/docs/tools/limits-monitor.html +1 -1
- data/tools/staticdocs/docs/tools/packet-viewer.html +1 -1
- data/tools/staticdocs/docs/tools/script-runner.html +1 -1
- data/tools/staticdocs/docs/tools/table-manager.html +1 -1
- data/tools/staticdocs/docs/tools/tlm-grapher.html +1 -1
- data/tools/staticdocs/docs/tools/tlm-viewer.html +1 -1
- data/tools/staticdocs/docs/tools.html +1 -1
- data/tools/staticdocs/docs.html +1 -1
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
- data/tools/staticdocs/index.html +1 -1
- data/tools/staticdocs/lunr-index-1743825503427.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +1 -1
- data/tools/staticdocs/search-doc-1743825503427.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +33 -32
- data/tools/staticdocs/assets/images/horizontalbox-ddf82f64de700286a742a71e0c1adebbc7e9822a0dff41139f41bc476e4fc4ce.png +0 -0
- data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
- data/tools/staticdocs/assets/js/1e02e6a3.f477eca7.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.4051cf46.js +0 -1
- data/tools/staticdocs/assets/js/31436304.a6b2eb4a.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.b84c55e3.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.67d1d92e.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.ef28d4e5.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.d2ce2753.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.81988bef.js +0 -1
- data/tools/staticdocs/assets/js/97535711.78660098.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.5e55992d.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.81e9c91d.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.08f58887.js +0 -1
- data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.94b76b52.js +0 -1
- data/tools/staticdocs/assets/js/ebec1ccb.f938ebaa.js +0 -1
- data/tools/staticdocs/assets/js/runtime~main.61a578da.js +0 -1
- data/tools/staticdocs/lunr-index-1741317069195.json +0 -1
- data/tools/staticdocs/search-doc-1741317069195.json +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/scripting-api" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Scripting API Guide | 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/docs/guides/scripting-api><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Scripting API Guide | OpenC3 Docs"><meta data-rh=true name=description content="Scripting API methods, deprecations and migrations"><meta data-rh=true property=og:description content="Scripting API methods, deprecations and migrations"><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/docs/guides/scripting-api><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api 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 aria-current=page class="navbar__item navbar__link navbar__link--active" 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"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing_microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/guides><span itemprop=name>Guides</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Scripting API Guide</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Scripting API Guide</h1></header><p>This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.</p>
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/scripting-api" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Scripting API Guide | 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/docs/guides/scripting-api><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Scripting API Guide | OpenC3 Docs"><meta data-rh=true name=description content="Scripting API methods, deprecations and migrations"><meta data-rh=true property=og:description content="Scripting API methods, deprecations and migrations"><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/docs/guides/scripting-api><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api 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 aria-current=page class="navbar__item navbar__link navbar__link--active" 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"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/guides><span itemprop=name>Guides</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Scripting API Guide</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Scripting API Guide</h1></header><p>This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.</p>
|
|
2
2
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=concepts>Concepts<a href=#concepts class=hash-link aria-label="Direct link to Concepts" title="Direct link to Concepts"></a></h2>
|
|
3
3
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=programming-languages>Programming Languages<a href=#programming-languages class=hash-link aria-label="Direct link to Programming Languages" title="Direct link to Programming Languages"></a></h3>
|
|
4
4
|
<p>COSMOS scripting is implemented using either Ruby or Python. Ruby and Python are very similar scripting languages and in many cases the COSMOS APIs are identical between the two. This guide is written to support both with additional language specific information found in the <a href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a>.</p>
|
|
@@ -458,6 +458,13 @@
|
|
|
458
458
|
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Target Name<td>Name of the target</table>
|
|
459
459
|
<p>Ruby / Python Example:</p>
|
|
460
460
|
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">get_all_tlm_names</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> ["ADCS", "HEALTH_STATUS", ...]</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
461
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=get_all_tlm_item_names>get_all_tlm_item_names<a href=#get_all_tlm_item_names class=hash-link aria-label="Direct link to get_all_tlm_item_names" title="Direct link to get_all_tlm_item_names"></a></h3>
|
|
462
|
+
<p>Returns all the item names for every packet in a target</p>
|
|
463
|
+
<p>Ruby / Python Syntax:</p>
|
|
464
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">get_all_tlm_item_names</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"<Target Name>"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
465
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Target Name<td>Name of the target</table>
|
|
466
|
+
<p>Ruby / Python Example:</p>
|
|
467
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">get_all_tlm_item_names</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> ["ARY", "ARY2", "ASCIICMD", "ATTPROGRESS", ...]</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
461
468
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=get_tlm>get_tlm<a href=#get_tlm class=hash-link aria-label="Direct link to get_tlm" title="Direct link to get_tlm"></a></h3>
|
|
462
469
|
<blockquote>
|
|
463
470
|
<p>Since 5.13.0, since 5.0.0 as get_telemetry</p>
|
|
@@ -927,7 +934,7 @@
|
|
|
927
934
|
<p>Ruby Example:</p>
|
|
928
935
|
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Full example of using table_create_binary and then editing the binary</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">require</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'openc3/tools/table_manager/table_config'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># This returns a hash: {"filename"=>"INST/tables/bin/MCConfigurationTable.bin"}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> table_create_binary</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST/tables/config/MCConfigurationTable_def.txt"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">file </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> get_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'filename'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table_binary </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Get the definition file so we can process the binary</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">def_file </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> get_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST/tables/config/MCConfigurationTable_def.txt"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Access the internal TableConfig to process the definition</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">config </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> OpenC3</span><span class="token double-colon punctuation" style="color:rgb(199, 146, 234)">::</span><span class="token plain">TableConfig</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">process_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">def_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">path</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Grab the table by the definition name, e.g. TABLE "MC_Configuration"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'MC_CONFIGURATION'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Now you can read or write individual items in the table</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">write</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"MEMORY_SCRUBBING"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DISABLE"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Finally write the table.buffer (the binary) back to storage</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">put_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST/tables/bin/MCConfigurationTable_NoScrub.bin"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">buffer</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
929
936
|
<p>Python Example:</p>
|
|
930
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#
|
|
937
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Full example of using table_create_binary and then editing the binary</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> openc3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">tools</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">table_manager</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">table_config </span><span class="token keyword" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> TableConfig</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Returns a dict: {'filename': 'INST/tables/bin/ConfigTables.bin'}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> table_create_binary</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST2/tables/config/ConfigTables_def.txt"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token builtin" style="color:rgb(130, 170, 255)">file</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> get_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">'filename'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table_binary </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Get the definition file so we can process the binary</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">def_file </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> get_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST2/tables/config/MCConfigurationTable_def.txt"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Access the internal TableConfig to process the definition</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">config </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> TableConfig</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">process_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">def_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Grab the table by the definition name, e.g. TABLE "MC_Configuration"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'MC_CONFIGURATION'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Now you can read or write individual items in the table</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">write</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"MEMORY_SCRUBBING"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"DISABLE"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Finally write the table.buffer (the binary) back to storage</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">put_target_file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST2/tables/bin/MCConfigurationTable_NoScrub.bin"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> table</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token builtin" style="color:rgb(130, 170, 255)">buffer</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
931
938
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=table_create_report>table_create_report<a href=#table_create_report class=hash-link aria-label="Direct link to table_create_report" title="Direct link to table_create_report"></a></h3>
|
|
932
939
|
<blockquote>
|
|
933
940
|
<p>Since 6.1.0</p>
|
|
@@ -1080,6 +1087,7 @@
|
|
|
1080
1087
|
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">script_delete</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST/procedures/checks.rb"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1081
1088
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=script_run>script_run<a href=#script_run class=hash-link aria-label="Direct link to script_run" title="Direct link to script_run"></a></h3>
|
|
1082
1089
|
<p>Runs a script in Script Runner. The script will run in the background and can be opened in Script Runner by selecting Script->Execution Status and then connecting to it.</p>
|
|
1090
|
+
<p>Note: In Enterprise, initialize_offline_access must have been called at least once for the user who calls this method.</p>
|
|
1083
1091
|
<p>Ruby / Python Syntax:</p>
|
|
1084
1092
|
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">script_run</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"<Script Name>"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1085
1093
|
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Script Name<td>Full path name of the script starting with the target</table>
|
|
@@ -1440,4 +1448,26 @@ Consider breaking code like this into a separate file and using either require/l
|
|
|
1440
1448
|
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">Tool Name</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">Configuration Name</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> local_mode</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1441
1449
|
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Tool Name<td>Name of the tool<tr><td>Configuration Name<td>Name of the configuration<tr><td>local_mode<td>Whether to delete the configuration in local mode</table>
|
|
1442
1450
|
<p>Ruby / Python Example:</p>
|
|
1443
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'telemetry_grapher'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'adcs'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/scripting-api.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/script-writing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#concepts class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href=#programming-languages class="table-of-contents__link toc-highlight">Programming Languages</a><li><a href=#using-script-runner class="table-of-contents__link toc-highlight">Using Script Runner</a><li><a href=#telemetry-types class="table-of-contents__link toc-highlight">Telemetry Types</a></ul><li><a href=#script-runner-api class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href=#migration-from-cosmos-v5-to-v6 class="table-of-contents__link toc-highlight">Migration from COSMOS v5 to v6</a><li><a href=#migration-from-cosmos-v4-to-v5 class="table-of-contents__link toc-highlight">Migration from COSMOS v4 to v5</a></ul><li><a href=#retrieving-user-input class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href=#ask class="table-of-contents__link toc-highlight">ask</a><li><a href=#ask_string class="table-of-contents__link toc-highlight">ask_string</a><li><a href=#message_box class="table-of-contents__link toc-highlight">message_box</a><li><a href=#vertical_message_box class="table-of-contents__link toc-highlight">vertical_message_box</a><li><a href=#combo_box class="table-of-contents__link toc-highlight">combo_box</a><li><a href=#get_target_file class="table-of-contents__link toc-highlight">get_target_file</a><li><a href=#put_target_file class="table-of-contents__link toc-highlight">put_target_file</a><li><a href=#delete_target_file class="table-of-contents__link toc-highlight">delete_target_file</a><li><a href=#open_file_dialog class="table-of-contents__link toc-highlight">open_file_dialog</a><li><a href=#open_files_dialog class="table-of-contents__link toc-highlight">open_files_dialog</a></ul><li><a href=#providing-information-to-the-user class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href=#prompt class="table-of-contents__link toc-highlight">prompt</a></ul><li><a href=#commands class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href=#cmd class="table-of-contents__link toc-highlight">cmd</a><li><a href=#cmd_no_range_check class="table-of-contents__link toc-highlight">cmd_no_range_check</a><li><a href=#cmd_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a><li><a href=#cmd_no_checks class="table-of-contents__link toc-highlight">cmd_no_checks</a><li><a href=#cmd_raw class="table-of-contents__link toc-highlight">cmd_raw</a><li><a href=#cmd_raw_no_range_check class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a><li><a href=#cmd_raw_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a><li><a href=#cmd_raw_no_checks class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a><li><a href=#build_cmd class="table-of-contents__link toc-highlight">build_cmd</a><li><a href=#enable_cmd class="table-of-contents__link toc-highlight">enable_cmd</a><li><a href=#disable_cmd class="table-of-contents__link toc-highlight">disable_cmd</a><li><a href=#send_raw class="table-of-contents__link toc-highlight">send_raw</a><li><a href=#get_all_cmds class="table-of-contents__link toc-highlight">get_all_cmds</a><li><a href=#get_all_cmd_names class="table-of-contents__link toc-highlight">get_all_cmd_names</a><li><a href=#get_cmd class="table-of-contents__link toc-highlight">get_cmd</a><li><a href=#get_param class="table-of-contents__link toc-highlight">get_param</a><li><a href=#get_cmd_buffer class="table-of-contents__link toc-highlight">get_cmd_buffer</a><li><a href=#get_cmd_hazardous class="table-of-contents__link toc-highlight">get_cmd_hazardous</a><li><a href=#get_cmd_value class="table-of-contents__link toc-highlight">get_cmd_value</a><li><a href=#get_cmd_time class="table-of-contents__link toc-highlight">get_cmd_time</a><li><a href=#get_cmd_cnt class="table-of-contents__link toc-highlight">get_cmd_cnt</a><li><a href=#get_cmd_cnts class="table-of-contents__link toc-highlight">get_cmd_cnts</a><li><a href=#critical_cmd_status class="table-of-contents__link toc-highlight">critical_cmd_status</a><li><a href=#critical_cmd_approve class="table-of-contents__link toc-highlight">critical_cmd_approve</a><li><a href=#critical_cmd_reject class="table-of-contents__link toc-highlight">critical_cmd_reject</a><li><a href=#critical_cmd_can_approve class="table-of-contents__link toc-highlight">critical_cmd_can_approve</a></ul><li><a href=#handling-telemetry class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href=#check-check_raw-check_formatted-check_with_units class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a><li><a href=#check_tolerance class="table-of-contents__link toc-highlight">check_tolerance</a><li><a href=#check_expression class="table-of-contents__link toc-highlight">check_expression</a><li><a href=#check_exception class="table-of-contents__link toc-highlight">check_exception</a><li><a href=#tlm-tlm_raw-tlm_formatted-tlm_with_units class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a><li><a href=#get_tlm_buffer class="table-of-contents__link toc-highlight">get_tlm_buffer</a><li><a href=#get_tlm_packet class="table-of-contents__link toc-highlight">get_tlm_packet</a><li><a href=#get_tlm_values class="table-of-contents__link toc-highlight">get_tlm_values</a><li><a href=#get_all_tlm class="table-of-contents__link toc-highlight">get_all_tlm</a><li><a href=#get_all_tlm_names class="table-of-contents__link toc-highlight">get_all_tlm_names</a><li><a href=#get_tlm class="table-of-contents__link toc-highlight">get_tlm</a><li><a href=#get_item class="table-of-contents__link toc-highlight">get_item</a><li><a href=#get_tlm_cnt class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#set_tlm class="table-of-contents__link toc-highlight">set_tlm</a><li><a href=#inject_tlm class="table-of-contents__link toc-highlight">inject_tlm</a><li><a href=#override_tlm class="table-of-contents__link toc-highlight">override_tlm</a><li><a href=#normalize_tlm class="table-of-contents__link toc-highlight">normalize_tlm</a><li><a href=#get_overrides class="table-of-contents__link toc-highlight">get_overrides</a></ul><li><a href=#packet-data-subscriptions class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href=#subscribe_packets class="table-of-contents__link toc-highlight">subscribe_packets</a><li><a href=#get_packets class="table-of-contents__link toc-highlight">get_packets</a><li><a href=#get_tlm_cnt-1 class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#get_tlm_cnts class="table-of-contents__link toc-highlight">get_tlm_cnts</a><li><a href=#get_packet_derived_items class="table-of-contents__link toc-highlight">get_packet_derived_items</a></ul><li><a href=#delays class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href=#wait class="table-of-contents__link toc-highlight">wait</a><li><a href=#wait_tolerance class="table-of-contents__link toc-highlight">wait_tolerance</a><li><a href=#wait_expression class="table-of-contents__link toc-highlight">wait_expression</a><li><a href=#wait_packet class="table-of-contents__link toc-highlight">wait_packet</a><li><a href=#wait_check class="table-of-contents__link toc-highlight">wait_check</a><li><a href=#wait_check_tolerance class="table-of-contents__link toc-highlight">wait_check_tolerance</a><li><a href=#wait_check_expression class="table-of-contents__link toc-highlight">wait_check_expression</a><li><a href=#wait_check_packet class="table-of-contents__link toc-highlight">wait_check_packet</a></ul><li><a href=#limits class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href=#limits_enabled-limits_enabled class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a><li><a href=#enable_limits class="table-of-contents__link toc-highlight">enable_limits</a><li><a href=#disable_limits class="table-of-contents__link toc-highlight">disable_limits</a><li><a href=#enable_limits_group class="table-of-contents__link toc-highlight">enable_limits_group</a><li><a href=#disable_limits_group class="table-of-contents__link toc-highlight">disable_limits_group</a><li><a href=#get_limits_groups class="table-of-contents__link toc-highlight">get_limits_groups</a><li><a href=#set_limits_set class="table-of-contents__link toc-highlight">set_limits_set</a><li><a href=#get_limits_set class="table-of-contents__link toc-highlight">get_limits_set</a><li><a href=#get_limits_sets class="table-of-contents__link toc-highlight">get_limits_sets</a><li><a href=#get_limits class="table-of-contents__link toc-highlight">get_limits</a><li><a href=#set_limits class="table-of-contents__link toc-highlight">set_limits</a><li><a href=#get_out_of_limits class="table-of-contents__link toc-highlight">get_out_of_limits</a><li><a href=#get_overall_limits_state class="table-of-contents__link toc-highlight">get_overall_limits_state</a><li><a href=#get_limits_events class="table-of-contents__link toc-highlight">get_limits_events</a></ul><li><a href=#plugins--packages class="table-of-contents__link toc-highlight">Plugins / Packages</a><ul><li><a href=#plugin_list class="table-of-contents__link toc-highlight">plugin_list</a><li><a href=#plugin_get class="table-of-contents__link toc-highlight">plugin_get</a><li><a href=#package_list class="table-of-contents__link toc-highlight">package_list</a></ul><li><a href=#targets class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href=#get_target_names class="table-of-contents__link toc-highlight">get_target_names</a><li><a href=#get_target class="table-of-contents__link toc-highlight">get_target</a><li><a href=#get_target_interfaces class="table-of-contents__link toc-highlight">get_target_interfaces</a></ul><li><a href=#interfaces class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href=#get_interface class="table-of-contents__link toc-highlight">get_interface</a><li><a href=#get_interface_names class="table-of-contents__link toc-highlight">get_interface_names</a><li><a href=#connect_interface class="table-of-contents__link toc-highlight">connect_interface</a><li><a href=#disconnect_interface class="table-of-contents__link toc-highlight">disconnect_interface</a><li><a href=#start_raw_logging_interface class="table-of-contents__link toc-highlight">start_raw_logging_interface</a><li><a href=#stop_raw_logging_interface class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a><li><a href=#get_all_interface_info class="table-of-contents__link toc-highlight">get_all_interface_info</a><li><a href=#map_target_to_interface class="table-of-contents__link toc-highlight">map_target_to_interface</a><li><a href=#interface_cmd class="table-of-contents__link toc-highlight">interface_cmd</a><li><a href=#interface_protocol_cmd class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></ul><li><a href=#routers class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href=#connect_router class="table-of-contents__link toc-highlight">connect_router</a><li><a href=#disconnect_router class="table-of-contents__link toc-highlight">disconnect_router</a><li><a href=#get_router_names class="table-of-contents__link toc-highlight">get_router_names</a><li><a href=#get_router class="table-of-contents__link toc-highlight">get_router</a><li><a href=#get_all_router_info class="table-of-contents__link toc-highlight">get_all_router_info</a><li><a href=#start_raw_logging_router class="table-of-contents__link toc-highlight">start_raw_logging_router</a><li><a href=#stop_raw_logging_router class="table-of-contents__link toc-highlight">stop_raw_logging_router</a><li><a href=#router_cmd class="table-of-contents__link toc-highlight">router_cmd</a><li><a href=#router_protocol_cmd class="table-of-contents__link toc-highlight">router_protocol_cmd</a></ul><li><a href=#tables class="table-of-contents__link toc-highlight">Tables</a><ul><li><a href=#table_create_binary class="table-of-contents__link toc-highlight">table_create_binary</a><li><a href=#table_create_report class="table-of-contents__link toc-highlight">table_create_report</a></ul><li><a href=#stashing-data class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href=#stash_set class="table-of-contents__link toc-highlight">stash_set</a><li><a href=#stash_get class="table-of-contents__link toc-highlight">stash_get</a><li><a href=#stash_all class="table-of-contents__link toc-highlight">stash_all</a><li><a href=#stash_keys class="table-of-contents__link toc-highlight">stash_keys</a><li><a href=#stash_delete class="table-of-contents__link toc-highlight">stash_delete</a></ul><li><a href=#telemetry-screens class="table-of-contents__link toc-highlight">Telemetry Screens</a><ul><li><a href=#display_screen class="table-of-contents__link toc-highlight">display_screen</a><li><a href=#clear_screen class="table-of-contents__link toc-highlight">clear_screen</a><li><a href=#clear_all_screens class="table-of-contents__link toc-highlight">clear_all_screens</a><li><a href=#delete_screen class="table-of-contents__link toc-highlight">delete_screen</a><li><a href=#get_screen_list class="table-of-contents__link toc-highlight">get_screen_list</a><li><a href=#get_screen_definition class="table-of-contents__link toc-highlight">get_screen_definition</a><li><a href=#create_screen class="table-of-contents__link toc-highlight">create_screen</a><li><a href=#local_screen class="table-of-contents__link toc-highlight">local_screen</a></ul><li><a href=#script-runner-scripts class="table-of-contents__link toc-highlight">Script Runner Scripts</a><ul><li><a href=#start class="table-of-contents__link toc-highlight">start</a><li><a href=#load_utility class="table-of-contents__link toc-highlight">load_utility</a><li><a href=#script_list class="table-of-contents__link toc-highlight">script_list</a><li><a href=#script_create class="table-of-contents__link toc-highlight">script_create</a><li><a href=#script_body class="table-of-contents__link toc-highlight">script_body</a><li><a href=#script_delete class="table-of-contents__link toc-highlight">script_delete</a><li><a href=#script_run class="table-of-contents__link toc-highlight">script_run</a><li><a href=#script_lock class="table-of-contents__link toc-highlight">script_lock</a><li><a href=#script_unlock class="table-of-contents__link toc-highlight">script_unlock</a><li><a href=#script_syntax_check class="table-of-contents__link toc-highlight">script_syntax_check</a><li><a href=#script_instrumented class="table-of-contents__link toc-highlight">script_instrumented</a><li><a href=#script_delete_all_breakpoints class="table-of-contents__link toc-highlight">script_delete_all_breakpoints</a><li><a href=#step_mode class="table-of-contents__link toc-highlight">step_mode</a><li><a href=#run_mode class="table-of-contents__link toc-highlight">run_mode</a><li><a href=#disconnect_script class="table-of-contents__link toc-highlight">disconnect_script</a><li><a href=#running_script_list class="table-of-contents__link toc-highlight">running_script_list</a><li><a href=#running_script_get class="table-of-contents__link toc-highlight">running_script_get</a><li><a href=#running_script_stop class="table-of-contents__link toc-highlight">running_script_stop</a><li><a href=#running_script_pause class="table-of-contents__link toc-highlight">running_script_pause</a><li><a href=#running_script_retry class="table-of-contents__link toc-highlight">running_script_retry</a><li><a href=#running_script_go class="table-of-contents__link toc-highlight">running_script_go</a><li><a href=#running_script_step class="table-of-contents__link toc-highlight">running_script_step</a><li><a href=#running_script_delete class="table-of-contents__link toc-highlight">running_script_delete</a><li><a href=#completed_script_list class="table-of-contents__link toc-highlight">completed_script_list</a></ul><li><a href=#script-runner-settings class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href=#set_line_delay class="table-of-contents__link toc-highlight">set_line_delay</a><li><a href=#get_line_delay class="table-of-contents__link toc-highlight">get_line_delay</a><li><a href=#set_max_output class="table-of-contents__link toc-highlight">set_max_output</a><li><a href=#get_max_output class="table-of-contents__link toc-highlight">get_max_output</a><li><a href=#disable_instrumentation class="table-of-contents__link toc-highlight">disable_instrumentation</a></ul><li><a href=#script-runner-suites class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href=#add_group-add_group_setup-add_group_teardown-add_script class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></ul><li><a href=#timelines class="table-of-contents__link toc-highlight">Timelines</a><ul><li><a href=#list_timelines class="table-of-contents__link toc-highlight">list_timelines</a><li><a href=#create_timeline class="table-of-contents__link toc-highlight">create_timeline</a><li><a href=#get_timeline class="table-of-contents__link toc-highlight">get_timeline</a><li><a href=#set_timeline_color class="table-of-contents__link toc-highlight">set_timeline_color</a><li><a href=#delete_timeline class="table-of-contents__link toc-highlight">delete_timeline</a><li><a href=#create_timeline_activity class="table-of-contents__link toc-highlight">create_timeline_activity</a><li><a href=#get_timeline_activity class="table-of-contents__link toc-highlight">get_timeline_activity</a><li><a href=#get_timeline_activities class="table-of-contents__link toc-highlight">get_timeline_activities</a><li><a href=#delete_timeline_activity class="table-of-contents__link toc-highlight">delete_timeline_activity</a></ul><li><a href=#metadata class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href=#metadata_all class="table-of-contents__link toc-highlight">metadata_all</a><li><a href=#metadata_get class="table-of-contents__link toc-highlight">metadata_get</a><li><a href=#metadata_set class="table-of-contents__link toc-highlight">metadata_set</a><li><a href=#metadata_update class="table-of-contents__link toc-highlight">metadata_update</a><li><a href=#metadata_input class="table-of-contents__link toc-highlight">metadata_input</a></ul><li><a href=#settings class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href=#list_settings class="table-of-contents__link toc-highlight">list_settings</a><li><a href=#get_all_settings class="table-of-contents__link toc-highlight">get_all_settings</a><li><a href=#get_setting-get_settings class="table-of-contents__link toc-highlight">get_setting, get_settings</a><li><a href=#set_setting class="table-of-contents__link toc-highlight">set_setting</a></ul><li><a href=#configuration class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href=#config_tool_names class="table-of-contents__link toc-highlight">config_tool_names</a><li><a href=#list_configs class="table-of-contents__link toc-highlight">list_configs</a><li><a href=#load_config class="table-of-contents__link toc-highlight">load_config</a><li><a href=#save_config class="table-of-contents__link toc-highlight">save_config</a><li><a href=#delete_config class="table-of-contents__link toc-highlight">delete_config</a></ul></ul></div></div></div></div></main></div></div></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>
|
|
1451
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'telemetry_grapher'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'adcs'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1452
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=offline-access>Offline Access<a href=#offline-access class=hash-link aria-label="Direct link to Offline Access" title="Direct link to Offline Access"></a></h2>
|
|
1453
|
+
<p>An offline access token is required to execute scripts in COSMOS Enterprise. These methods support client side creation, testing, and
|
|
1454
|
+
setting of the offline_access_token.</p>
|
|
1455
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=initialize_offline_access>initialize_offline_access<a href=#initialize_offline_access class=hash-link aria-label="Direct link to initialize_offline_access" title="Direct link to initialize_offline_access"></a></h3>
|
|
1456
|
+
<p>Creates and sets the offline access token for the user. Note: calling this method is required before executing any api methods that require an offline access token like script_run (Enterprise Only). This method must be called OUTSIDE of ScriptRunner as it is needed in order to start a script in the first place.</p>
|
|
1457
|
+
<p>Ruby Example:</p>
|
|
1458
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># First setup environment variables. See examples/external_script.rb</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">initialize_offline_access</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">script_run</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST/procedures/collect.rb"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1459
|
+
<p>Python Example:</p>
|
|
1460
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># First setup environment variables. See examples/external_script.py</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">initialize_offline_access</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">script_run</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST2/procedures/collect.py"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1461
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=offline_access_needed>offline_access_needed<a href=#offline_access_needed class=hash-link aria-label="Direct link to offline_access_needed" title="Direct link to offline_access_needed"></a></h3>
|
|
1462
|
+
<p>Returns true if the user needs to generate an offline access token. Note this will only be true if the user is at least authorized to view scripts, otherwise it will always be false if script_view permission is not available for the user.</p>
|
|
1463
|
+
<p>Ruby Example:</p>
|
|
1464
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">result </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> offline_access_needed</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> true</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1465
|
+
<p>Python Example:</p>
|
|
1466
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">result </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> offline_access_needed</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> False</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1467
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=set_offline_access>set_offline_access<a href=#set_offline_access class=hash-link aria-label="Direct link to set_offline_access" title="Direct link to set_offline_access"></a></h3>
|
|
1468
|
+
<p>Sets the offline access token in the backend. Note: You probably don't need to call this method directly, as it will be called by initialize_offline_access().</p>
|
|
1469
|
+
<p>Ruby / Python Syntax:</p>
|
|
1470
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">set_offline_access</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">offline_access_token</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
1471
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>offline_access_token<td>Keycloak generated refresh token that contains the offline_access openid scope</table>
|
|
1472
|
+
<p>Ruby / Python Example:</p>
|
|
1473
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">set_offline_access</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">offline_access_token</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/scripting-api.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/script-writing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#concepts class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href=#programming-languages class="table-of-contents__link toc-highlight">Programming Languages</a><li><a href=#using-script-runner class="table-of-contents__link toc-highlight">Using Script Runner</a><li><a href=#telemetry-types class="table-of-contents__link toc-highlight">Telemetry Types</a></ul><li><a href=#script-runner-api class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href=#migration-from-cosmos-v5-to-v6 class="table-of-contents__link toc-highlight">Migration from COSMOS v5 to v6</a><li><a href=#migration-from-cosmos-v4-to-v5 class="table-of-contents__link toc-highlight">Migration from COSMOS v4 to v5</a></ul><li><a href=#retrieving-user-input class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href=#ask class="table-of-contents__link toc-highlight">ask</a><li><a href=#ask_string class="table-of-contents__link toc-highlight">ask_string</a><li><a href=#message_box class="table-of-contents__link toc-highlight">message_box</a><li><a href=#vertical_message_box class="table-of-contents__link toc-highlight">vertical_message_box</a><li><a href=#combo_box class="table-of-contents__link toc-highlight">combo_box</a><li><a href=#get_target_file class="table-of-contents__link toc-highlight">get_target_file</a><li><a href=#put_target_file class="table-of-contents__link toc-highlight">put_target_file</a><li><a href=#delete_target_file class="table-of-contents__link toc-highlight">delete_target_file</a><li><a href=#open_file_dialog class="table-of-contents__link toc-highlight">open_file_dialog</a><li><a href=#open_files_dialog class="table-of-contents__link toc-highlight">open_files_dialog</a></ul><li><a href=#providing-information-to-the-user class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href=#prompt class="table-of-contents__link toc-highlight">prompt</a></ul><li><a href=#commands class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href=#cmd class="table-of-contents__link toc-highlight">cmd</a><li><a href=#cmd_no_range_check class="table-of-contents__link toc-highlight">cmd_no_range_check</a><li><a href=#cmd_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a><li><a href=#cmd_no_checks class="table-of-contents__link toc-highlight">cmd_no_checks</a><li><a href=#cmd_raw class="table-of-contents__link toc-highlight">cmd_raw</a><li><a href=#cmd_raw_no_range_check class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a><li><a href=#cmd_raw_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a><li><a href=#cmd_raw_no_checks class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a><li><a href=#build_cmd class="table-of-contents__link toc-highlight">build_cmd</a><li><a href=#enable_cmd class="table-of-contents__link toc-highlight">enable_cmd</a><li><a href=#disable_cmd class="table-of-contents__link toc-highlight">disable_cmd</a><li><a href=#send_raw class="table-of-contents__link toc-highlight">send_raw</a><li><a href=#get_all_cmds class="table-of-contents__link toc-highlight">get_all_cmds</a><li><a href=#get_all_cmd_names class="table-of-contents__link toc-highlight">get_all_cmd_names</a><li><a href=#get_cmd class="table-of-contents__link toc-highlight">get_cmd</a><li><a href=#get_param class="table-of-contents__link toc-highlight">get_param</a><li><a href=#get_cmd_buffer class="table-of-contents__link toc-highlight">get_cmd_buffer</a><li><a href=#get_cmd_hazardous class="table-of-contents__link toc-highlight">get_cmd_hazardous</a><li><a href=#get_cmd_value class="table-of-contents__link toc-highlight">get_cmd_value</a><li><a href=#get_cmd_time class="table-of-contents__link toc-highlight">get_cmd_time</a><li><a href=#get_cmd_cnt class="table-of-contents__link toc-highlight">get_cmd_cnt</a><li><a href=#get_cmd_cnts class="table-of-contents__link toc-highlight">get_cmd_cnts</a><li><a href=#critical_cmd_status class="table-of-contents__link toc-highlight">critical_cmd_status</a><li><a href=#critical_cmd_approve class="table-of-contents__link toc-highlight">critical_cmd_approve</a><li><a href=#critical_cmd_reject class="table-of-contents__link toc-highlight">critical_cmd_reject</a><li><a href=#critical_cmd_can_approve class="table-of-contents__link toc-highlight">critical_cmd_can_approve</a></ul><li><a href=#handling-telemetry class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href=#check-check_raw-check_formatted-check_with_units class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a><li><a href=#check_tolerance class="table-of-contents__link toc-highlight">check_tolerance</a><li><a href=#check_expression class="table-of-contents__link toc-highlight">check_expression</a><li><a href=#check_exception class="table-of-contents__link toc-highlight">check_exception</a><li><a href=#tlm-tlm_raw-tlm_formatted-tlm_with_units class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a><li><a href=#get_tlm_buffer class="table-of-contents__link toc-highlight">get_tlm_buffer</a><li><a href=#get_tlm_packet class="table-of-contents__link toc-highlight">get_tlm_packet</a><li><a href=#get_tlm_values class="table-of-contents__link toc-highlight">get_tlm_values</a><li><a href=#get_all_tlm class="table-of-contents__link toc-highlight">get_all_tlm</a><li><a href=#get_all_tlm_names class="table-of-contents__link toc-highlight">get_all_tlm_names</a><li><a href=#get_all_tlm_item_names class="table-of-contents__link toc-highlight">get_all_tlm_item_names</a><li><a href=#get_tlm class="table-of-contents__link toc-highlight">get_tlm</a><li><a href=#get_item class="table-of-contents__link toc-highlight">get_item</a><li><a href=#get_tlm_cnt class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#set_tlm class="table-of-contents__link toc-highlight">set_tlm</a><li><a href=#inject_tlm class="table-of-contents__link toc-highlight">inject_tlm</a><li><a href=#override_tlm class="table-of-contents__link toc-highlight">override_tlm</a><li><a href=#normalize_tlm class="table-of-contents__link toc-highlight">normalize_tlm</a><li><a href=#get_overrides class="table-of-contents__link toc-highlight">get_overrides</a></ul><li><a href=#packet-data-subscriptions class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href=#subscribe_packets class="table-of-contents__link toc-highlight">subscribe_packets</a><li><a href=#get_packets class="table-of-contents__link toc-highlight">get_packets</a><li><a href=#get_tlm_cnt-1 class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#get_tlm_cnts class="table-of-contents__link toc-highlight">get_tlm_cnts</a><li><a href=#get_packet_derived_items class="table-of-contents__link toc-highlight">get_packet_derived_items</a></ul><li><a href=#delays class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href=#wait class="table-of-contents__link toc-highlight">wait</a><li><a href=#wait_tolerance class="table-of-contents__link toc-highlight">wait_tolerance</a><li><a href=#wait_expression class="table-of-contents__link toc-highlight">wait_expression</a><li><a href=#wait_packet class="table-of-contents__link toc-highlight">wait_packet</a><li><a href=#wait_check class="table-of-contents__link toc-highlight">wait_check</a><li><a href=#wait_check_tolerance class="table-of-contents__link toc-highlight">wait_check_tolerance</a><li><a href=#wait_check_expression class="table-of-contents__link toc-highlight">wait_check_expression</a><li><a href=#wait_check_packet class="table-of-contents__link toc-highlight">wait_check_packet</a></ul><li><a href=#limits class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href=#limits_enabled-limits_enabled class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a><li><a href=#enable_limits class="table-of-contents__link toc-highlight">enable_limits</a><li><a href=#disable_limits class="table-of-contents__link toc-highlight">disable_limits</a><li><a href=#enable_limits_group class="table-of-contents__link toc-highlight">enable_limits_group</a><li><a href=#disable_limits_group class="table-of-contents__link toc-highlight">disable_limits_group</a><li><a href=#get_limits_groups class="table-of-contents__link toc-highlight">get_limits_groups</a><li><a href=#set_limits_set class="table-of-contents__link toc-highlight">set_limits_set</a><li><a href=#get_limits_set class="table-of-contents__link toc-highlight">get_limits_set</a><li><a href=#get_limits_sets class="table-of-contents__link toc-highlight">get_limits_sets</a><li><a href=#get_limits class="table-of-contents__link toc-highlight">get_limits</a><li><a href=#set_limits class="table-of-contents__link toc-highlight">set_limits</a><li><a href=#get_out_of_limits class="table-of-contents__link toc-highlight">get_out_of_limits</a><li><a href=#get_overall_limits_state class="table-of-contents__link toc-highlight">get_overall_limits_state</a><li><a href=#get_limits_events class="table-of-contents__link toc-highlight">get_limits_events</a></ul><li><a href=#plugins--packages class="table-of-contents__link toc-highlight">Plugins / Packages</a><ul><li><a href=#plugin_list class="table-of-contents__link toc-highlight">plugin_list</a><li><a href=#plugin_get class="table-of-contents__link toc-highlight">plugin_get</a><li><a href=#package_list class="table-of-contents__link toc-highlight">package_list</a></ul><li><a href=#targets class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href=#get_target_names class="table-of-contents__link toc-highlight">get_target_names</a><li><a href=#get_target class="table-of-contents__link toc-highlight">get_target</a><li><a href=#get_target_interfaces class="table-of-contents__link toc-highlight">get_target_interfaces</a></ul><li><a href=#interfaces class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href=#get_interface class="table-of-contents__link toc-highlight">get_interface</a><li><a href=#get_interface_names class="table-of-contents__link toc-highlight">get_interface_names</a><li><a href=#connect_interface class="table-of-contents__link toc-highlight">connect_interface</a><li><a href=#disconnect_interface class="table-of-contents__link toc-highlight">disconnect_interface</a><li><a href=#start_raw_logging_interface class="table-of-contents__link toc-highlight">start_raw_logging_interface</a><li><a href=#stop_raw_logging_interface class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a><li><a href=#get_all_interface_info class="table-of-contents__link toc-highlight">get_all_interface_info</a><li><a href=#map_target_to_interface class="table-of-contents__link toc-highlight">map_target_to_interface</a><li><a href=#interface_cmd class="table-of-contents__link toc-highlight">interface_cmd</a><li><a href=#interface_protocol_cmd class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></ul><li><a href=#routers class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href=#connect_router class="table-of-contents__link toc-highlight">connect_router</a><li><a href=#disconnect_router class="table-of-contents__link toc-highlight">disconnect_router</a><li><a href=#get_router_names class="table-of-contents__link toc-highlight">get_router_names</a><li><a href=#get_router class="table-of-contents__link toc-highlight">get_router</a><li><a href=#get_all_router_info class="table-of-contents__link toc-highlight">get_all_router_info</a><li><a href=#start_raw_logging_router class="table-of-contents__link toc-highlight">start_raw_logging_router</a><li><a href=#stop_raw_logging_router class="table-of-contents__link toc-highlight">stop_raw_logging_router</a><li><a href=#router_cmd class="table-of-contents__link toc-highlight">router_cmd</a><li><a href=#router_protocol_cmd class="table-of-contents__link toc-highlight">router_protocol_cmd</a></ul><li><a href=#tables class="table-of-contents__link toc-highlight">Tables</a><ul><li><a href=#table_create_binary class="table-of-contents__link toc-highlight">table_create_binary</a><li><a href=#table_create_report class="table-of-contents__link toc-highlight">table_create_report</a></ul><li><a href=#stashing-data class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href=#stash_set class="table-of-contents__link toc-highlight">stash_set</a><li><a href=#stash_get class="table-of-contents__link toc-highlight">stash_get</a><li><a href=#stash_all class="table-of-contents__link toc-highlight">stash_all</a><li><a href=#stash_keys class="table-of-contents__link toc-highlight">stash_keys</a><li><a href=#stash_delete class="table-of-contents__link toc-highlight">stash_delete</a></ul><li><a href=#telemetry-screens class="table-of-contents__link toc-highlight">Telemetry Screens</a><ul><li><a href=#display_screen class="table-of-contents__link toc-highlight">display_screen</a><li><a href=#clear_screen class="table-of-contents__link toc-highlight">clear_screen</a><li><a href=#clear_all_screens class="table-of-contents__link toc-highlight">clear_all_screens</a><li><a href=#delete_screen class="table-of-contents__link toc-highlight">delete_screen</a><li><a href=#get_screen_list class="table-of-contents__link toc-highlight">get_screen_list</a><li><a href=#get_screen_definition class="table-of-contents__link toc-highlight">get_screen_definition</a><li><a href=#create_screen class="table-of-contents__link toc-highlight">create_screen</a><li><a href=#local_screen class="table-of-contents__link toc-highlight">local_screen</a></ul><li><a href=#script-runner-scripts class="table-of-contents__link toc-highlight">Script Runner Scripts</a><ul><li><a href=#start class="table-of-contents__link toc-highlight">start</a><li><a href=#load_utility class="table-of-contents__link toc-highlight">load_utility</a><li><a href=#script_list class="table-of-contents__link toc-highlight">script_list</a><li><a href=#script_create class="table-of-contents__link toc-highlight">script_create</a><li><a href=#script_body class="table-of-contents__link toc-highlight">script_body</a><li><a href=#script_delete class="table-of-contents__link toc-highlight">script_delete</a><li><a href=#script_run class="table-of-contents__link toc-highlight">script_run</a><li><a href=#script_lock class="table-of-contents__link toc-highlight">script_lock</a><li><a href=#script_unlock class="table-of-contents__link toc-highlight">script_unlock</a><li><a href=#script_syntax_check class="table-of-contents__link toc-highlight">script_syntax_check</a><li><a href=#script_instrumented class="table-of-contents__link toc-highlight">script_instrumented</a><li><a href=#script_delete_all_breakpoints class="table-of-contents__link toc-highlight">script_delete_all_breakpoints</a><li><a href=#step_mode class="table-of-contents__link toc-highlight">step_mode</a><li><a href=#run_mode class="table-of-contents__link toc-highlight">run_mode</a><li><a href=#disconnect_script class="table-of-contents__link toc-highlight">disconnect_script</a><li><a href=#running_script_list class="table-of-contents__link toc-highlight">running_script_list</a><li><a href=#running_script_get class="table-of-contents__link toc-highlight">running_script_get</a><li><a href=#running_script_stop class="table-of-contents__link toc-highlight">running_script_stop</a><li><a href=#running_script_pause class="table-of-contents__link toc-highlight">running_script_pause</a><li><a href=#running_script_retry class="table-of-contents__link toc-highlight">running_script_retry</a><li><a href=#running_script_go class="table-of-contents__link toc-highlight">running_script_go</a><li><a href=#running_script_step class="table-of-contents__link toc-highlight">running_script_step</a><li><a href=#running_script_delete class="table-of-contents__link toc-highlight">running_script_delete</a><li><a href=#completed_script_list class="table-of-contents__link toc-highlight">completed_script_list</a></ul><li><a href=#script-runner-settings class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href=#set_line_delay class="table-of-contents__link toc-highlight">set_line_delay</a><li><a href=#get_line_delay class="table-of-contents__link toc-highlight">get_line_delay</a><li><a href=#set_max_output class="table-of-contents__link toc-highlight">set_max_output</a><li><a href=#get_max_output class="table-of-contents__link toc-highlight">get_max_output</a><li><a href=#disable_instrumentation class="table-of-contents__link toc-highlight">disable_instrumentation</a></ul><li><a href=#script-runner-suites class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href=#add_group-add_group_setup-add_group_teardown-add_script class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></ul><li><a href=#timelines class="table-of-contents__link toc-highlight">Timelines</a><ul><li><a href=#list_timelines class="table-of-contents__link toc-highlight">list_timelines</a><li><a href=#create_timeline class="table-of-contents__link toc-highlight">create_timeline</a><li><a href=#get_timeline class="table-of-contents__link toc-highlight">get_timeline</a><li><a href=#set_timeline_color class="table-of-contents__link toc-highlight">set_timeline_color</a><li><a href=#delete_timeline class="table-of-contents__link toc-highlight">delete_timeline</a><li><a href=#create_timeline_activity class="table-of-contents__link toc-highlight">create_timeline_activity</a><li><a href=#get_timeline_activity class="table-of-contents__link toc-highlight">get_timeline_activity</a><li><a href=#get_timeline_activities class="table-of-contents__link toc-highlight">get_timeline_activities</a><li><a href=#delete_timeline_activity class="table-of-contents__link toc-highlight">delete_timeline_activity</a></ul><li><a href=#metadata class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href=#metadata_all class="table-of-contents__link toc-highlight">metadata_all</a><li><a href=#metadata_get class="table-of-contents__link toc-highlight">metadata_get</a><li><a href=#metadata_set class="table-of-contents__link toc-highlight">metadata_set</a><li><a href=#metadata_update class="table-of-contents__link toc-highlight">metadata_update</a><li><a href=#metadata_input class="table-of-contents__link toc-highlight">metadata_input</a></ul><li><a href=#settings class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href=#list_settings class="table-of-contents__link toc-highlight">list_settings</a><li><a href=#get_all_settings class="table-of-contents__link toc-highlight">get_all_settings</a><li><a href=#get_setting-get_settings class="table-of-contents__link toc-highlight">get_setting, get_settings</a><li><a href=#set_setting class="table-of-contents__link toc-highlight">set_setting</a></ul><li><a href=#configuration class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href=#config_tool_names class="table-of-contents__link toc-highlight">config_tool_names</a><li><a href=#list_configs class="table-of-contents__link toc-highlight">list_configs</a><li><a href=#load_config class="table-of-contents__link toc-highlight">load_config</a><li><a href=#save_config class="table-of-contents__link toc-highlight">save_config</a><li><a href=#delete_config class="table-of-contents__link toc-highlight">delete_config</a></ul><li><a href=#offline-access class="table-of-contents__link toc-highlight">Offline Access</a><ul><li><a href=#initialize_offline_access class="table-of-contents__link toc-highlight">initialize_offline_access</a><li><a href=#offline_access_needed class="table-of-contents__link toc-highlight">offline_access_needed</a><li><a href=#set_offline_access class="table-of-contents__link toc-highlight">set_offline_access</a></ul></ul></div></div></div></div></main></div></div></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 +1 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Guides | 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/docs/guides><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Guides | 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/docs/guides><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides 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 aria-current=page class="navbar__item navbar__link navbar__link--active" 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"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing_microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Guides</span><meta itemprop=position content=1></ul></nav><header><h1 class=title_AulG>Guides</h1></header><article class=margin-top--lg><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/bridges><h2 class="text--truncate cardTitle_HoSo" title=Bridges>🌉<!-- --> <!-- -->Bridges</h2><p class="text--truncate cardDescription_c27F" title="Bridge data into COSMOS from serial ports, PCI, etc">Bridge data into COSMOS from serial ports, PCI, etc</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/cfs><h2 class="text--truncate cardTitle_HoSo" title="COSMOS and NASA cFS">🚀<!-- --> <!-- -->COSMOS and NASA cFS</h2><p class="text--truncate cardDescription_c27F" title="Tutorial for integrating with NASA cFS">Tutorial for integrating with NASA cFS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/custom-widgets><h2 class="text--truncate cardTitle_HoSo" title="Custom Widgets">🔨<!-- --> <!-- -->Custom Widgets</h2><p class="text--truncate cardDescription_c27F" title="How to build custom widgets for use in Telemetry Viewer">How to build custom widgets for use in Telemetry Viewer</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/exposing_microservices><h2 class="text--truncate cardTitle_HoSo" title="Exposing Microservices">🚪<!-- --> <!-- -->Exposing Microservices</h2><p class="text--truncate cardDescription_c27F" title="Provide external accessibility to microservices">Provide external accessibility to microservices</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/little-endian-bitfields><h2 class="text--truncate cardTitle_HoSo" title="Little Endian Bitfields">💻<!-- --> <!-- -->Little Endian Bitfields</h2><p class="text--truncate cardDescription_c27F" title="Defining little endian bitfields">Defining little endian bitfields</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/local-mode><h2 class="text--truncate cardTitle_HoSo" title="Local Mode">🧭<!-- --> <!-- -->Local Mode</h2><p class="text--truncate cardDescription_c27F" title="Edit scripts and screens directly on the host file system">Edit scripts and screens directly on the host file system</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/logging><h2 class="text--truncate cardTitle_HoSo" title=Logging>🪵<!-- --> <!-- -->Logging</h2><p class="text--truncate cardDescription_c27F" title="The log files in COSMOS">The log files in COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/monitoring><h2 class="text--truncate cardTitle_HoSo" title=Monitoring>🖥️<!-- --> <!-- -->Monitoring</h2><p class="text--truncate cardDescription_c27F" title="Various ways to monitor COSMOS internals">Various ways to monitor COSMOS internals</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/performance><h2 class="text--truncate cardTitle_HoSo" title=Performance>📊<!-- --> <!-- -->Performance</h2><p class="text--truncate cardDescription_c27F" title="Hardware requirements like memory and CPU">Hardware requirements like memory and CPU</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/raspberrypi><h2 class="text--truncate cardTitle_HoSo" title="Raspberry Pi">🍓<!-- --> <!-- -->Raspberry Pi</h2><p class="text--truncate cardDescription_c27F" title="Running COSMOS on a Raspberry Pi">Running COSMOS on a Raspberry Pi</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/script-writing><h2 class="text--truncate cardTitle_HoSo" title="Script Writing Guide">🏃➡️<!-- --> <!-- -->Script Writing Guide</h2><p class="text--truncate cardDescription_c27F" title="Key concepts and best practices for script writing">Key concepts and best practices for script writing</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/scripting-api><h2 class="text--truncate cardTitle_HoSo" title="Scripting API Guide">📝<!-- --> <!-- -->Scripting API Guide</h2><p class="text--truncate cardDescription_c27F" title="Scripting API methods, deprecations and migrations">Scripting API methods, deprecations and migrations</p></a></article></section></article><footer class=margin-top--lg><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/tools/tlm-viewer><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Telemetry Viewer</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/bridges><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Bridges</div></a></nav></footer></div></div></main></div></div></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="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Guides | 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/docs/guides><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Guides | 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/docs/guides><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides 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 aria-current=page class="navbar__item navbar__link navbar__link--active" 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"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Guides</span><meta itemprop=position content=1></ul></nav><header><h1 class=title_AulG>Guides</h1></header><article class=margin-top--lg><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/bridges><h2 class="text--truncate cardTitle_HoSo" title=Bridges>🌉<!-- --> <!-- -->Bridges</h2><p class="text--truncate cardDescription_c27F" title="Bridge data into COSMOS from serial ports, PCI, etc">Bridge data into COSMOS from serial ports, PCI, etc</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/cfs><h2 class="text--truncate cardTitle_HoSo" title="COSMOS and NASA cFS">🚀<!-- --> <!-- -->COSMOS and NASA cFS</h2><p class="text--truncate cardDescription_c27F" title="Tutorial for integrating with NASA cFS">Tutorial for integrating with NASA cFS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/custom-widgets><h2 class="text--truncate cardTitle_HoSo" title="Custom Widgets">🔨<!-- --> <!-- -->Custom Widgets</h2><p class="text--truncate cardDescription_c27F" title="How to build custom widgets for use in Telemetry Viewer">How to build custom widgets for use in Telemetry Viewer</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/dynamic-packets><h2 class="text--truncate cardTitle_HoSo" title="Dynamic Packets">🧱<!-- --> <!-- -->Dynamic Packets</h2><p class="text--truncate cardDescription_c27F" title="How COSMOS dynamically builds packets">How COSMOS dynamically builds packets</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/exposing-microservices><h2 class="text--truncate cardTitle_HoSo" title="Exposing Microservices">🚪<!-- --> <!-- -->Exposing Microservices</h2><p class="text--truncate cardDescription_c27F" title="Provide external accessibility to microservices">Provide external accessibility to microservices</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/little-endian-bitfields><h2 class="text--truncate cardTitle_HoSo" title="Little Endian Bitfields">💻<!-- --> <!-- -->Little Endian Bitfields</h2><p class="text--truncate cardDescription_c27F" title="Defining little endian bitfields">Defining little endian bitfields</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/local-mode><h2 class="text--truncate cardTitle_HoSo" title="Local Mode">🧭<!-- --> <!-- -->Local Mode</h2><p class="text--truncate cardDescription_c27F" title="Edit scripts and screens directly on the host file system">Edit scripts and screens directly on the host file system</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/logging><h2 class="text--truncate cardTitle_HoSo" title=Logging>🪵<!-- --> <!-- -->Logging</h2><p class="text--truncate cardDescription_c27F" title="The log files in COSMOS">The log files in COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/monitoring><h2 class="text--truncate cardTitle_HoSo" title=Monitoring>🖥️<!-- --> <!-- -->Monitoring</h2><p class="text--truncate cardDescription_c27F" title="Various ways to monitor COSMOS internals">Various ways to monitor COSMOS internals</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/performance><h2 class="text--truncate cardTitle_HoSo" title=Performance>📊<!-- --> <!-- -->Performance</h2><p class="text--truncate cardDescription_c27F" title="Hardware requirements like memory and CPU">Hardware requirements like memory and CPU</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/raspberrypi><h2 class="text--truncate cardTitle_HoSo" title="Raspberry Pi">🍓<!-- --> <!-- -->Raspberry Pi</h2><p class="text--truncate cardDescription_c27F" title="Running COSMOS on a Raspberry Pi">Running COSMOS on a Raspberry Pi</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/script-writing><h2 class="text--truncate cardTitle_HoSo" title="Script Writing Guide">🏃➡️<!-- --> <!-- -->Script Writing Guide</h2><p class="text--truncate cardDescription_c27F" title="Key concepts and best practices for script writing">Key concepts and best practices for script writing</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/guides/scripting-api><h2 class="text--truncate cardTitle_HoSo" title="Scripting API Guide">📝<!-- --> <!-- -->Scripting API Guide</h2><p class="text--truncate cardDescription_c27F" title="Scripting API methods, deprecations and migrations">Scripting API methods, deprecations and migrations</p></a></article></section></article><footer class=margin-top--lg><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/tools/tlm-viewer><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Telemetry Viewer</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/bridges><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Bridges</div></a></nav></footer></div></div></main></div></div></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,4 +1,4 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-meta/contributing" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Contributing | 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/docs/meta/contributing><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Contributing | OpenC3 Docs"><meta data-rh=true name=description content="Contributing to COSMOS using the github workflow"><meta data-rh=true property=og:description content="Contributing to COSMOS using the github workflow"><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/docs/meta/contributing><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/meta/contributing hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/meta/contributing hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-meta/contributing" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Contributing | 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/docs/meta/contributing><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Contributing | OpenC3 Docs"><meta data-rh=true name=description content="Contributing to COSMOS using the github workflow"><meta data-rh=true property=og:description content="Contributing to COSMOS using the github workflow"><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/docs/meta/contributing><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/meta/contributing hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/meta/contributing 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 aria-current=page class="navbar__item navbar__link navbar__link--active" 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"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Collapse sidebar category 'Meta'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/meta/contributing>Contributing</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/meta/licenses>Licenses</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/meta/philosophy>Philosophy</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/meta/xtce>XTCE Support</a></ul><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/meta><span itemprop=name>Meta</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Contributing</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Contributing</h1></header><p>So you've got an awesome idea to throw into COSMOS. Great! This is the basic process:</p>
|
|
2
2
|
<ol>
|
|
3
3
|
<li>Fork the project on Github</li>
|
|
4
4
|
<li>Create a feature branch</li>
|