openc3-cosmos-tool-docs 5.14.2 → 5.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/js/019369f3.3a124fd7.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.c85ad785.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.4d6b8154.js +1 -0
- data/tools/staticdocs/assets/js/{07876b9c.bcadf7df.js → 07876b9c.b8d12431.js} +1 -1
- data/tools/staticdocs/assets/js/078dbab0.45ea4593.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.dda04dbb.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.317b47d0.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.a946540f.js +1 -0
- data/tools/staticdocs/assets/js/13196248.d8f8ef9f.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.50ee3d02.js +1 -0
- data/tools/staticdocs/assets/js/1b2b4b61.2556cd65.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.75fe47dd.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.77516494.js +1 -0
- data/tools/staticdocs/assets/js/2601.ca992ab9.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +1 -0
- data/tools/staticdocs/assets/js/{2923e883.779dc8d3.js → 2923e883.ed90d0a7.js} +1 -1
- data/tools/staticdocs/assets/js/2bb7bf90.c642620c.js +1 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.f84c6956.js +1 -0
- data/tools/staticdocs/assets/js/{3df159b4.edd6dd5f.js → 3df159b4.ff98bfab.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.c318f801.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e29e2db3.js +1 -0
- data/tools/staticdocs/assets/js/42170351.15f2f1e3.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.4e7d6a97.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.3f1245d5.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.769f5473.js +1 -0
- data/tools/staticdocs/assets/js/{55cdbca5.e73bdb1a.js → 55cdbca5.695875ea.js} +1 -1
- data/tools/staticdocs/assets/js/5723.f6123e37.js +1 -0
- data/tools/staticdocs/assets/js/{9142.cab356f2.js → 5778.7d36f1c2.js} +1 -1
- data/tools/staticdocs/assets/js/5b233ba7.0029b2f5.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.84f6ce9e.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.8667906a.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.91d6735f.js +1 -0
- data/tools/staticdocs/assets/js/{5fe211ef.debbddaa.js → 5fe211ef.1d991947.js} +1 -1
- data/tools/staticdocs/assets/js/{64630c4f.81b3c47d.js → 64630c4f.a229ae1d.js} +1 -1
- data/tools/staticdocs/assets/js/6831b732.a77e4761.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.2700ad91.js +1 -0
- data/tools/staticdocs/assets/js/{6b210247.b50441ee.js → 6b210247.074332a1.js} +1 -1
- data/tools/staticdocs/assets/js/6b65133b.109a6bef.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.67f5a7a4.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.5fca8d68.js +1 -0
- data/tools/staticdocs/assets/js/{75373ac0.f35aa5aa.js → 75373ac0.6a0a4fa2.js} +1 -1
- data/tools/staticdocs/assets/js/{75e64983.9153c043.js → 75e64983.e31793e1.js} +1 -1
- data/tools/staticdocs/assets/js/7760.7f593c4f.js +2 -0
- data/tools/staticdocs/assets/js/7918.25ec42db.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.a8f59357.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.de702714.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.0f25fdc3.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.66b19930.js +1 -0
- data/tools/staticdocs/assets/js/{97535711.14f1644d.js → 97535711.ddc0f5af.js} +1 -1
- data/tools/staticdocs/assets/js/{99581c43.de6d7078.js → 99581c43.0767018a.js} +1 -1
- data/tools/staticdocs/assets/js/99b59eea.d4dd9989.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.30085d79.js +1 -0
- data/tools/staticdocs/assets/js/a507c363.198e9246.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.48b6c791.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.cfb3492e.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.065a8213.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.b4c6c1b8.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.66d95cb7.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.655a4097.js +1 -0
- data/tools/staticdocs/assets/js/{bd0034eb.ca5c64eb.js → bd0034eb.ff7f6265.js} +1 -1
- data/tools/staticdocs/assets/js/c24eae19.db62873a.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.f669adda.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.6ee752c7.js +1 -0
- data/tools/staticdocs/assets/js/{d1b923aa.c606e06a.js → d1b923aa.e7ee188a.js} +1 -1
- data/tools/staticdocs/assets/js/d1bfc316.963c2477.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.31d82456.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.905988ec.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.80e1a28b.js +1 -0
- data/tools/staticdocs/assets/js/{d797a795.b35ee94f.js → d797a795.5725bf2b.js} +1 -1
- data/tools/staticdocs/assets/js/d8ca4191.56c22a69.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.16d983a0.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.c35b153c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.88b0f00b.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.3aa571ae.js +1 -0
- data/tools/staticdocs/assets/js/ebec1ccb.a801549e.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.0b19ae07.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.57eeb84b.js +1 -0
- data/tools/staticdocs/assets/js/main.a6fe34c0.js +2 -0
- data/tools/staticdocs/assets/js/runtime~main.256dc9a2.js +1 -0
- data/tools/staticdocs/docs/configuration/command.html +168 -74
- data/tools/staticdocs/docs/configuration/format.html +51 -22
- data/tools/staticdocs/docs/configuration/interfaces.html +78 -23
- data/tools/staticdocs/docs/configuration/plugins.html +162 -113
- data/tools/staticdocs/docs/configuration/protocols.html +86 -46
- data/tools/staticdocs/docs/configuration/ssl-tls.html +102 -31
- data/tools/staticdocs/docs/configuration/table.html +113 -48
- data/tools/staticdocs/docs/configuration/target.html +29 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +441 -183
- data/tools/staticdocs/docs/configuration/telemetry.html +175 -75
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +54 -11
- data/tools/staticdocs/docs/development/developing.html +78 -27
- data/tools/staticdocs/docs/development/host-install.html +20 -7
- data/tools/staticdocs/docs/development/json-api.html +30 -18
- data/tools/staticdocs/docs/development/log-structure.html +11 -11
- data/tools/staticdocs/docs/development/roadmap.html +11 -11
- data/tools/staticdocs/docs/development/streaming-api.html +81 -9
- data/tools/staticdocs/docs/development/testing.html +23 -14
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/generators.html +107 -33
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +70 -22
- data/tools/staticdocs/docs/getting-started/installation.html +33 -22
- data/tools/staticdocs/docs/getting-started/key_concepts.html +33 -33
- data/tools/staticdocs/docs/getting-started/podman.html +54 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +18 -18
- data/tools/staticdocs/docs/getting-started/upgrading.html +14 -9
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +61 -17
- data/tools/staticdocs/docs/guides/cfs.html +182 -42
- data/tools/staticdocs/docs/guides/custom-widgets.html +44 -17
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +12 -3
- data/tools/staticdocs/docs/guides/local-mode.html +18 -13
- data/tools/staticdocs/docs/guides/logging.html +10 -10
- data/tools/staticdocs/docs/guides/monitoring.html +135 -20
- data/tools/staticdocs/docs/guides/performance.html +24 -15
- data/tools/staticdocs/docs/guides/raspberrypi.html +22 -7
- data/tools/staticdocs/docs/guides/script-writing.html +387 -82
- data/tools/staticdocs/docs/guides/scripting-api.html +1339 -476
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +17 -12
- data/tools/staticdocs/docs/meta/licenses.html +28 -10
- data/tools/staticdocs/docs/meta/philosophy.html +2 -2
- data/tools/staticdocs/docs/meta/xtce.html +14 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/autonomic.html +20 -20
- data/tools/staticdocs/docs/tools/bucket-explorer.html +11 -11
- data/tools/staticdocs/docs/tools/calendar.html +19 -19
- data/tools/staticdocs/docs/tools/cmd-sender.html +13 -13
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +21 -21
- data/tools/staticdocs/docs/tools/data-extractor.html +24 -24
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +17 -17
- data/tools/staticdocs/docs/tools/packet-viewer.html +13 -13
- data/tools/staticdocs/docs/tools/script-runner.html +72 -33
- data/tools/staticdocs/docs/tools/table-manager.html +46 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +20 -20
- data/tools/staticdocs/docs/tools/tlm-viewer.html +15 -15
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +12 -12
- data/tools/staticdocs/index.html +2 -2
- data/tools/staticdocs/lunr-index-1710043920959.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1710043920959.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +86 -86
- data/tools/staticdocs/assets/js/019369f3.4c70e0f5.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.9fe67269.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.bec3d8d0.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.21af6e8e.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.821a434d.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.b7b2f0e7.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.69ac319c.js +0 -1
- data/tools/staticdocs/assets/js/13196248.50c46920.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.cd1ff3e4.js +0 -1
- data/tools/staticdocs/assets/js/1b2b4b61.bc9d9dae.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.a81749f4.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.8087c066.js +0 -1
- data/tools/staticdocs/assets/js/2684.36b8c775.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.b69bce6b.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.615ed3e3.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.4ee9bb2b.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.4c276089.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.dba1dcf4.js +0 -1
- data/tools/staticdocs/assets/js/42170351.7de5b38a.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.817db236.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.7c5b0f91.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.5600c9b0.js +0 -1
- data/tools/staticdocs/assets/js/5640.603af822.js +0 -2
- data/tools/staticdocs/assets/js/5b233ba7.816cf3c7.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.832101d0.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.29713d16.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.2a1df40b.js +0 -1
- data/tools/staticdocs/assets/js/6624.7d23f967.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.cb28ec2a.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.3f5260ea.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.3e207b70.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.f39c2a82.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.9247374f.js +0 -1
- data/tools/staticdocs/assets/js/80.7f39c110.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.1ad7ba44.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.ed8629f4.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.1efba1e7.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.05020154.js +0 -1
- data/tools/staticdocs/assets/js/99b59eea.ff86d64b.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.118681ad.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.d3e03463.js +0 -1
- data/tools/staticdocs/assets/js/a507c363.a5cb92f5.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.1e72219d.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.5e9c5fba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.bae800c5.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.ca25b65e.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.52733814.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.026c925c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.94275d3c.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.bd1deb3f.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6f45475a.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.65307471.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.1233a5c6.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.d43ffea3.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.32ff5b2f.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.5c73f3e4.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.694c3ff3.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.95630ed9.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.d4658c69.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.83046007.js +0 -1
- data/tools/staticdocs/assets/js/ebec1ccb.6f1d3fbf.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.b8e79235.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.a07830ee.js +0 -1
- data/tools/staticdocs/assets/js/main.4510cb33.js +0 -2
- data/tools/staticdocs/assets/js/runtime~main.87667807.js +0 -1
- data/tools/staticdocs/lunr-index-1707604600660.json +0 -1
- data/tools/staticdocs/search-doc-1707604600660.json +0 -1
- /data/tools/staticdocs/assets/js/{5640.603af822.js.LICENSE.txt → 7760.7f593c4f.js.LICENSE.txt} +0 -0
- /data/tools/staticdocs/assets/js/{main.4510cb33.js.LICENSE.txt → main.a6fe34c0.js.LICENSE.txt} +0 -0
|
@@ -4,333 +4,382 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
|
6
6
|
<title data-rh="true">Plugins | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><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/configuration/plugins"><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="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><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/configuration/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a4426211.css">
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.256dc9a2.js" defer="defer"></script>
|
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.a6fe34c0.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><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"></path></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><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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" 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/configuration/format">File Format</a></li><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/configuration/plugins">Plugins</a></li><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/configuration/target">Targets</a></li><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/configuration/command">Commands</a></li><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/configuration/telemetry">Telemetry</a></li><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/configuration/interfaces">Interfaces</a></li><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/configuration/protocols">Protocols</a></li><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/configuration/table">Tables</a></li><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/configuration/telemetry-screens">Screens</a></li><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/configuration/ssl-tls">SSL-TLS</a></li></ul></li><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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><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></li></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"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></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>Plugins</h1></header><h2
|
|
11
|
+
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><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"></path></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><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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" 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/configuration/format">File Format</a></li><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/configuration/plugins">Plugins</a></li><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/configuration/target">Targets</a></li><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/configuration/command">Commands</a></li><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/configuration/telemetry">Telemetry</a></li><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/configuration/interfaces">Interfaces</a></li><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/configuration/protocols">Protocols</a></li><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/configuration/table">Tables</a></li><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/configuration/telemetry-screens">Screens</a></li><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/configuration/ssl-tls">SSL-TLS</a></li></ul></li><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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><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></li></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"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></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>Plugins</h1></header><h2 id="introduction">Introduction</h2>
|
|
12
12
|
<p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
|
|
13
13
|
<p>Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality.</p>
|
|
14
14
|
<p>Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains.</p>
|
|
15
|
-
<h2
|
|
16
|
-
<h3
|
|
15
|
+
<h2 id="concepts">Concepts</h2>
|
|
16
|
+
<h3 id="target">Target</h3>
|
|
17
17
|
<p>Targets are the external pieces of hardware and/or software that COSMOS communicates with. These are things like Front End Processors (FEPs), ground support equipment (GSE), custom software tools, and pieces of hardware like satellites themselves. A target is anything that COSMOS can send commands to and receive telemetry from.</p>
|
|
18
|
-
<h3
|
|
18
|
+
<h3 id="interface">Interface</h3>
|
|
19
19
|
<p>Interfaces implement the physical connection to one or more targets. They are typically ethernet connections implemented using TCP or UDP but can be other connections like serial ports. Interfaces send commands to targets and receive telemetry from targets.</p>
|
|
20
|
-
<h3
|
|
20
|
+
<h3 id="router">Router</h3>
|
|
21
21
|
<p>Routers flow streams of telemetry packets out of COSMOS and receive streams of commands into COSMOS. The commands are forwarded by COSMOS to associated interfaces. Telemetry comes from associated interfaces.</p>
|
|
22
|
-
<h3
|
|
22
|
+
<h3 id="tool">Tool</h3>
|
|
23
23
|
<p>COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts.</p>
|
|
24
|
-
<h3
|
|
24
|
+
<h3 id="microservice">Microservice</h3>
|
|
25
25
|
<p>Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks.</p>
|
|
26
|
-
<h2
|
|
27
|
-
<p>COSMOS plugins have a well-defined directory structure described in detail in the <a href="
|
|
28
|
-
<h2
|
|
26
|
+
<h2 id="plugin-directory-structure">Plugin Directory Structure</h2>
|
|
27
|
+
<p>COSMOS plugins have a well-defined directory structure described in detail in the <a href="../getting-started/generators">Code Generator</a> documentation.</p>
|
|
28
|
+
<h2 id="plugintxt-configuration-file">plugin.txt Configuration File</h2>
|
|
29
29
|
<p>A plugin.txt configuration file is required for any COSMOS plugin. It declares the contents of the plugin and provides variables that allow the plugin to be configured at the time it is initially installed or upgraded.
|
|
30
30
|
This file follows the standard COSMOS configuration file format of keywords followed by zero or more space separated parameters. The following keywords are supported by the plugin.txt config file:</p>
|
|
31
|
-
<h2
|
|
31
|
+
<h2 id="variable">VARIABLE</h2>
|
|
32
32
|
<p><strong>Define a configurable variable for the plugin</strong></p>
|
|
33
33
|
<p>The VARIABLE keyword defines a variable that will be requested for the user to enter during plugin installation. Variables can be used to handle details of targets that are user defined such as specific IP addresses and ports. Variables should also be used to allow users to rename targets to whatever name they want and support multiple installations of the same target with different names. Variables can be used later in plugin.txt or in any other configuration file included in a plugin using Ruby ERB syntax. The variables are assigned to accessible local variables in the file. At a high level, ERB allows you to run Ruby code in configuration files.</p>
|
|
34
34
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Variable Name</td><td>The name of the variable</td><td>True</td></tr><tr><td>Default Value</td><td>Default value of the variable</td><td>True</td></tr></tbody></table>
|
|
35
|
-
<h2
|
|
35
|
+
<h2 id="needs_dependencies">NEEDS_DEPENDENCIES</h2>
|
|
36
36
|
<p></p><div class="right">(Since 5.5.0)</div><strong>Indicates the plugin needs dependencies and sets the GEM_HOME environment variable</strong><p></p>
|
|
37
37
|
<p>If the plugin has a top level lib folder or lists runtime dependencies in the gemspec, NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod.</p>
|
|
38
|
-
<h2
|
|
38
|
+
<h2 id="interface-1">INTERFACE</h2>
|
|
39
39
|
<p><strong>Defines a connection to a physical target</strong></p>
|
|
40
40
|
<p>Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol.</p>
|
|
41
41
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Interface Name</td><td>Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with '_INT' appended to the name, e.g. INST_INT for the INST target.</td><td>True</td></tr><tr><td>Filename</td><td>Ruby file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb</span></td><td>True</td></tr></tbody></table>
|
|
42
42
|
<p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
|
|
43
|
-
<h2
|
|
43
|
+
<h2 id="interface-modifiers">INTERFACE Modifiers</h2>
|
|
44
44
|
<p>The following keywords must follow a INTERFACE keyword.</p>
|
|
45
|
-
<h3
|
|
45
|
+
<h3 id="map_target">MAP_TARGET</h3>
|
|
46
46
|
<p><strong>Maps a target name to an interface</strong></p>
|
|
47
47
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target name to map to this interface</td><td>True</td></tr></tbody></table>
|
|
48
48
|
<p>Example Usage:</p>
|
|
49
|
-
<
|
|
50
|
-
|
|
49
|
+
<pre><code class="language-ruby">INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
|
|
50
|
+
MAP_TARGET DATA
|
|
51
|
+
</code></pre>
|
|
52
|
+
<h3 id="map_cmd_target">MAP_CMD_TARGET</h3>
|
|
51
53
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
|
|
52
54
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Command target name to map to this interface</td><td>True</td></tr></tbody></table>
|
|
53
55
|
<p>Example Usage:</p>
|
|
54
|
-
<
|
|
55
|
-
|
|
56
|
+
<pre><code class="language-ruby">INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
|
|
57
|
+
MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
|
|
58
|
+
</code></pre>
|
|
59
|
+
<h3 id="map_tlm_target">MAP_TLM_TARGET</h3>
|
|
56
60
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
|
|
57
61
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Telemetry target name to map to this interface</td><td>True</td></tr></tbody></table>
|
|
58
62
|
<p>Example Usage:</p>
|
|
59
|
-
<
|
|
60
|
-
|
|
63
|
+
<pre><code class="language-ruby">INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
|
|
64
|
+
MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
|
|
65
|
+
</code></pre>
|
|
66
|
+
<h3 id="dont_connect">DONT_CONNECT</h3>
|
|
61
67
|
<p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
|
|
62
|
-
<h3
|
|
68
|
+
<h3 id="dont_reconnect">DONT_RECONNECT</h3>
|
|
63
69
|
<p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
|
|
64
|
-
<h3
|
|
70
|
+
<h3 id="reconnect_delay">RECONNECT_DELAY</h3>
|
|
65
71
|
<p><strong>Reconnect delay in seconds</strong></p>
|
|
66
72
|
<p>If DONT_RECONNECT is not present the Server will try to reconnect to an interface if the connection is lost. Reconnect delay sets the interval in seconds between reconnect tries.</p>
|
|
67
73
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Delay</td><td>Delay in seconds between reconnect attempts. The default is 15 seconds.</td><td>True</td></tr></tbody></table>
|
|
68
|
-
<h3
|
|
74
|
+
<h3 id="disable_disconnect">DISABLE_DISCONNECT</h3>
|
|
69
75
|
<p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
|
|
70
76
|
<p>Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a 'production' environment where you would not want the user to inadvertantly disconnect from a target.</p>
|
|
71
|
-
<h3
|
|
77
|
+
<h3 id="log_raw">LOG_RAW</h3>
|
|
72
78
|
<p><strong>Deprecated, use LOG_STREAM</strong></p>
|
|
73
|
-
<h3
|
|
79
|
+
<h3 id="log_stream">LOG_STREAM</h3>
|
|
74
80
|
<p></p><div class="right">(Since 5.5.2)</div><strong>Log all data on the interface exactly as it is sent and received</strong><p></p>
|
|
75
81
|
<p>LOG_STREAM does not add any OpenC3 headers and thus can not be read by OpenC3 tools. It is primarily useful for low level debugging of an interface. You will have to manually parse these logs yourself using a hex editor or other application.</p>
|
|
76
82
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Cycle Time</td><td>Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute.</td><td>False</td></tr><tr><td>Cycle Size</td><td>Amount of data to write before cycling the log file. Default is 50MB.</td><td>False</td></tr><tr><td>Cycle Hour</td><td>The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil.</td><td>False</td></tr><tr><td>Cycle Minute</td><td>See Cycle Hour.</td><td>False</td></tr></tbody></table>
|
|
77
83
|
<p>Example Usage:</p>
|
|
78
|
-
<
|
|
79
|
-
|
|
84
|
+
<pre><code class="language-ruby">INTERFACE EXAMPLE example_interface.rb
|
|
85
|
+
# Override the default log time of 600
|
|
86
|
+
LOG_STREAM 60
|
|
87
|
+
</code></pre>
|
|
88
|
+
<h3 id="protocol">PROTOCOL</h3>
|
|
80
89
|
<p></p><div class="right">(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
|
|
81
90
|
<p>Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.<br><br> For information on creating your own custom protocol please see <a href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></p>
|
|
82
91
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>Whether to apply the protocol on incoming data, outgoing data, or both<br><br>Valid Values: <span class="values">READ, WRITE, READ_WRITE</span></td><td>True</td></tr><tr><td>Protocol Filename or Classname</td><td>Ruby filename or class name which implements the protocol</td><td>True</td></tr><tr><td>Protocol specific parameters</td><td>Additional parameters used by the protocol</td><td>False</td></tr></tbody></table>
|
|
83
92
|
<p>Example Usage:</p>
|
|
84
|
-
<
|
|
85
|
-
|
|
93
|
+
<pre><code class="language-ruby">INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil
|
|
94
|
+
MAP_TARGET DATA
|
|
95
|
+
# Rather than defining the LENGTH protocol on the INTERFACE line we define it here
|
|
96
|
+
PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11
|
|
97
|
+
INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
|
|
98
|
+
MAP_TARGET DATA
|
|
99
|
+
PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets
|
|
100
|
+
</code></pre>
|
|
101
|
+
<h3 id="option">OPTION</h3>
|
|
86
102
|
<p><strong>Set a parameter on an interface</strong></p>
|
|
87
103
|
<p>When an option is set the interface class calls the set_option method. Custom interfaces can override set_option to handle any additional options they want.</p>
|
|
88
104
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).</td><td>True</td></tr><tr><td>Parameters</td><td>Parameters to pass to the option</td><td>False</td></tr></tbody></table>
|
|
89
105
|
<p>Example Usage:</p>
|
|
90
|
-
<
|
|
91
|
-
|
|
106
|
+
<pre><code class="language-ruby">INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil
|
|
107
|
+
OPTION FLOW_CONTROL RTSCTS
|
|
108
|
+
OPTION DATA_BITS 8
|
|
109
|
+
</code></pre>
|
|
110
|
+
<h3 id="secret">SECRET</h3>
|
|
92
111
|
<p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
|
|
93
112
|
<p>Defines a secret for this interface and optionally assigns its value to an option</p>
|
|
94
113
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Option Name</td><td>Interface option to pass the secret value</td><td>False</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
|
|
95
114
|
<p>Example Usage:</p>
|
|
96
|
-
<
|
|
97
|
-
|
|
115
|
+
<pre><code class="language-ruby">SECRET ENV USERNAME ENV_USERNAME USERNAME
|
|
116
|
+
SECRET FILE KEY "/tmp/DATA/cert" KEY
|
|
117
|
+
</code></pre>
|
|
118
|
+
<h3 id="env">ENV</h3>
|
|
98
119
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
|
|
99
120
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
|
|
100
121
|
<p>Example Usage:</p>
|
|
101
|
-
<
|
|
102
|
-
|
|
122
|
+
<pre><code class="language-ruby">ENV COMPANY OpenC3
|
|
123
|
+
</code></pre>
|
|
124
|
+
<h3 id="work_dir">WORK_DIR</h3>
|
|
103
125
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
|
|
104
126
|
<p>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</p>
|
|
105
127
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
|
|
106
128
|
<p>Example Usage:</p>
|
|
107
|
-
<
|
|
108
|
-
|
|
129
|
+
<pre><code class="language-ruby">WORK_DIR '/openc3/lib/openc3/microservices'
|
|
130
|
+
</code></pre>
|
|
131
|
+
<h3 id="port">PORT</h3>
|
|
109
132
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
|
|
110
133
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
111
134
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
|
|
112
135
|
<p>Example Usage:</p>
|
|
113
|
-
<
|
|
114
|
-
|
|
136
|
+
<pre><code class="language-ruby">PORT 7272
|
|
137
|
+
</code></pre>
|
|
138
|
+
<h3 id="cmd">CMD</h3>
|
|
115
139
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
|
|
116
140
|
<p>Command line to execute to run the microservice.</p>
|
|
117
141
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
|
|
118
142
|
<p>Example Usage:</p>
|
|
119
|
-
<
|
|
120
|
-
|
|
143
|
+
<pre><code class="language-ruby">CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
|
|
144
|
+
</code></pre>
|
|
145
|
+
<h3 id="container">CONTAINER</h3>
|
|
121
146
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
|
|
122
147
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
|
|
123
148
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
|
|
124
|
-
<h3
|
|
149
|
+
<h3 id="route_prefix">ROUTE_PREFIX</h3>
|
|
125
150
|
<p></p><div class="right">(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
|
|
126
151
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
127
152
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
|
|
128
153
|
<p>Example Usage:</p>
|
|
129
|
-
<
|
|
130
|
-
|
|
154
|
+
<pre><code class="language-ruby">ROUTE_PREFIX /interface
|
|
155
|
+
</code></pre>
|
|
156
|
+
<h2 id="router-1">ROUTER</h2>
|
|
131
157
|
<p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
|
|
132
158
|
<p>Creates an router which receives command packets from their remote clients and sends them to associated interfaces. They receive telemetry packets from their interfaces and send them to their remote clients. This allows routers to be intermediaries between an external client and an actual device.</p>
|
|
133
159
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the router</td><td>True</td></tr><tr><td>Filename</td><td>Ruby file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb</span></td><td>True</td></tr></tbody></table>
|
|
134
160
|
<p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
|
|
135
|
-
<h2
|
|
161
|
+
<h2 id="target-1">TARGET</h2>
|
|
136
162
|
<p><strong>Defines a new target</strong></p>
|
|
137
163
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Folder Name</td><td>The target folder</td><td>True</td></tr><tr><td>Name</td><td>The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder.</td><td>True</td></tr></tbody></table>
|
|
138
164
|
<p>Example Usage:</p>
|
|
139
|
-
<
|
|
140
|
-
|
|
165
|
+
<pre><code class="language-ruby">TARGET INST INST
|
|
166
|
+
</code></pre>
|
|
167
|
+
<h2 id="target-modifiers">TARGET Modifiers</h2>
|
|
141
168
|
<p>The following keywords must follow a TARGET keyword.</p>
|
|
142
|
-
<h3
|
|
169
|
+
<h3 id="cmd_buffer_depth">CMD_BUFFER_DEPTH</h3>
|
|
143
170
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
|
|
144
171
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 5)</td><td>True</td></tr></tbody></table>
|
|
145
|
-
<h3
|
|
172
|
+
<h3 id="cmd_log_cycle_time">CMD_LOG_CYCLE_TIME</h3>
|
|
146
173
|
<p><strong>Command binary logs can be cycled on a time interval.</strong></p>
|
|
147
174
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
|
|
148
|
-
<h3
|
|
175
|
+
<h3 id="cmd_log_cycle_size">CMD_LOG_CYCLE_SIZE</h3>
|
|
149
176
|
<p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
150
177
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
|
|
151
|
-
<h3
|
|
178
|
+
<h3 id="cmd_log_retain_time">CMD_LOG_RETAIN_TIME</h3>
|
|
152
179
|
<p><strong>How long to keep raw command logs in seconds.</strong></p>
|
|
153
180
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
154
|
-
<h3
|
|
181
|
+
<h3 id="cmd_decom_log_cycle_time">CMD_DECOM_LOG_CYCLE_TIME</h3>
|
|
155
182
|
<p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
|
|
156
183
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
|
|
157
|
-
<h3
|
|
184
|
+
<h3 id="cmd_decom_log_cycle_size">CMD_DECOM_LOG_CYCLE_SIZE</h3>
|
|
158
185
|
<p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
159
186
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
|
|
160
|
-
<h3
|
|
187
|
+
<h3 id="cmd_decom_log_retain_time">CMD_DECOM_LOG_RETAIN_TIME</h3>
|
|
161
188
|
<p><strong>How long to keep decom command logs in seconds.</strong></p>
|
|
162
189
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
163
|
-
<h3
|
|
190
|
+
<h3 id="tlm_buffer_depth">TLM_BUFFER_DEPTH</h3>
|
|
164
191
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Number of telemetry packets to buffer to ensure logged in order</strong><p></p>
|
|
165
192
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 60)</td><td>True</td></tr></tbody></table>
|
|
166
|
-
<h3
|
|
193
|
+
<h3 id="tlm_log_cycle_time">TLM_LOG_CYCLE_TIME</h3>
|
|
167
194
|
<p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
|
|
168
195
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
|
|
169
|
-
<h3
|
|
196
|
+
<h3 id="tlm_log_cycle_size">TLM_LOG_CYCLE_SIZE</h3>
|
|
170
197
|
<p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
171
198
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
|
|
172
|
-
<h3
|
|
199
|
+
<h3 id="tlm_log_retain_time">TLM_LOG_RETAIN_TIME</h3>
|
|
173
200
|
<p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
|
|
174
201
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
175
|
-
<h3
|
|
202
|
+
<h3 id="tlm_decom_log_cycle_time">TLM_DECOM_LOG_CYCLE_TIME</h3>
|
|
176
203
|
<p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
|
|
177
204
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
|
|
178
|
-
<h3
|
|
205
|
+
<h3 id="tlm_decom_log_cycle_size">TLM_DECOM_LOG_CYCLE_SIZE</h3>
|
|
179
206
|
<p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
180
207
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
|
|
181
|
-
<h3
|
|
208
|
+
<h3 id="tlm_decom_log_retain_time">TLM_DECOM_LOG_RETAIN_TIME</h3>
|
|
182
209
|
<p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
|
|
183
210
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
184
|
-
<h3
|
|
211
|
+
<h3 id="reduced_minute_log_retain_time">REDUCED_MINUTE_LOG_RETAIN_TIME</h3>
|
|
185
212
|
<p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
|
|
186
213
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
187
|
-
<h3
|
|
214
|
+
<h3 id="reduced_hour_log_retain_time">REDUCED_HOUR_LOG_RETAIN_TIME</h3>
|
|
188
215
|
<p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
|
|
189
216
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
190
|
-
<h3
|
|
217
|
+
<h3 id="reduced_day_log_retain_time">REDUCED_DAY_LOG_RETAIN_TIME</h3>
|
|
191
218
|
<p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
|
|
192
219
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced day telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
193
|
-
<h3
|
|
220
|
+
<h3 id="log_retain_time">LOG_RETAIN_TIME</h3>
|
|
194
221
|
<p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
|
|
195
222
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all regular telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
196
|
-
<h3
|
|
223
|
+
<h3 id="reduced_log_retain_time">REDUCED_LOG_RETAIN_TIME</h3>
|
|
197
224
|
<p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
|
|
198
225
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all reduced telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
|
|
199
|
-
<h3
|
|
226
|
+
<h3 id="cleanup_poll_time">CLEANUP_POLL_TIME</h3>
|
|
200
227
|
<p><strong>Period at which to run the cleanup process.</strong></p>
|
|
201
228
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)</td><td>True</td></tr></tbody></table>
|
|
202
|
-
<h3
|
|
229
|
+
<h3 id="reducer_disable">REDUCER_DISABLE</h3>
|
|
203
230
|
<p><strong>Disables the data reduction microservice for the target</strong></p>
|
|
204
|
-
<h3
|
|
231
|
+
<h3 id="reducer_max_cpu_utilization">REDUCER_MAX_CPU_UTILIZATION</h3>
|
|
205
232
|
<p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
|
|
206
233
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Percentage</td><td>0 to 100 percent (default = 30)</td><td>True</td></tr></tbody></table>
|
|
207
|
-
<h3
|
|
234
|
+
<h3 id="target_microservice">TARGET_MICROSERVICE</h3>
|
|
208
235
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
|
|
209
236
|
<p>Can be used to give more resources to processing that is falling behind. If defined multiple times for the same type, will create multiple processes. Each process can be given specific packets to process with the PACKET keyword.</p>
|
|
210
237
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP</td><td>True</td></tr></tbody></table>
|
|
211
|
-
<h3
|
|
238
|
+
<h3 id="packet">PACKET</h3>
|
|
212
239
|
<p></p><div class="right">(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
|
|
213
240
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Packet Name</td><td>The packet name. Does not apply to REDUCER or CLEANUP target microservice types.</td><td>True</td></tr></tbody></table>
|
|
214
|
-
<h3
|
|
241
|
+
<h3 id="disable_erb">DISABLE_ERB</h3>
|
|
215
242
|
<p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
216
243
|
<p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
|
|
217
244
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
|
|
218
|
-
<h2
|
|
245
|
+
<h2 id="microservice-1">MICROSERVICE</h2>
|
|
219
246
|
<p><strong>Defines a new microservice</strong></p>
|
|
220
247
|
<p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
|
|
221
248
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Microservice Folder Name</td><td>The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName</td><td>True</td></tr><tr><td>Microservice Name</td><td>The specific name of this instance of the microservice in the OpenC3 system</td><td>True</td></tr></tbody></table>
|
|
222
249
|
<p>Example Usage:</p>
|
|
223
|
-
<
|
|
224
|
-
|
|
250
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
251
|
+
</code></pre>
|
|
252
|
+
<h2 id="microservice-modifiers">MICROSERVICE Modifiers</h2>
|
|
225
253
|
<p>The following keywords must follow a MICROSERVICE keyword.</p>
|
|
226
|
-
<h3
|
|
254
|
+
<h3 id="env-1">ENV</h3>
|
|
227
255
|
<p><strong>Sets an environment variable in the microservice.</strong></p>
|
|
228
256
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
|
|
229
257
|
<p>Example Usage:</p>
|
|
230
|
-
<
|
|
231
|
-
|
|
258
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
259
|
+
ENV COMPANY OpenC3
|
|
260
|
+
</code></pre>
|
|
261
|
+
<h3 id="work_dir-1">WORK_DIR</h3>
|
|
232
262
|
<p><strong>Set the working directory</strong></p>
|
|
233
263
|
<p>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</p>
|
|
234
264
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
|
|
235
265
|
<p>Example Usage:</p>
|
|
236
|
-
<
|
|
237
|
-
|
|
266
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
267
|
+
WORK_DIR .
|
|
268
|
+
</code></pre>
|
|
269
|
+
<h3 id="port-1">PORT</h3>
|
|
238
270
|
<p></p><div class="right">(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
|
|
239
271
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
240
272
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
|
|
241
273
|
<p>Example Usage:</p>
|
|
242
|
-
<
|
|
243
|
-
|
|
274
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
275
|
+
PORT 7272
|
|
276
|
+
</code></pre>
|
|
277
|
+
<h3 id="topic">TOPIC</h3>
|
|
244
278
|
<p><strong>Associate a Redis topic</strong></p>
|
|
245
279
|
<p>Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics.</p>
|
|
246
280
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Topic Name</td><td>Redis Topic to associate with the microservice</td><td>True</td></tr></tbody></table>
|
|
247
281
|
<p>Example Usage:</p>
|
|
248
|
-
<
|
|
249
|
-
|
|
282
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
283
|
+
# Manually assigning topics is an advanced topic and requires
|
|
284
|
+
# intimate knowledge of the internal COSMOS data structures.
|
|
285
|
+
TOPIC DEFAULT__openc3_log_messages
|
|
286
|
+
TOPIC DEFAULT__TELEMETRY__EXAMPLE__STATUS
|
|
287
|
+
</code></pre>
|
|
288
|
+
<h3 id="target_name">TARGET_NAME</h3>
|
|
250
289
|
<p><strong>Associate a OpenC3 target</strong></p>
|
|
251
290
|
<p>OpenC3 target to associate with the microservice. For standard OpenC3 microservices such as decom_microservice this causes the target configuration to get loaded into the container for the microservice.</p>
|
|
252
291
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>OpenC3 target to associate with the microservice</td><td>True</td></tr></tbody></table>
|
|
253
292
|
<p>Example Usage:</p>
|
|
254
|
-
<
|
|
255
|
-
|
|
293
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
294
|
+
TARGET_NAME EXAMPLE
|
|
295
|
+
</code></pre>
|
|
296
|
+
<h3 id="cmd-1">CMD</h3>
|
|
256
297
|
<p><strong>Command line to execute to run the microservice.</strong></p>
|
|
257
298
|
<p>Command line to execute to run the microservice.</p>
|
|
258
299
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
|
|
259
300
|
<p>Example Usage:</p>
|
|
260
|
-
<
|
|
261
|
-
|
|
301
|
+
<pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
|
|
302
|
+
CMD ruby example_target.rb
|
|
303
|
+
</code></pre>
|
|
304
|
+
<h3 id="option-1">OPTION</h3>
|
|
262
305
|
<p><strong>Pass an option to the microservice</strong></p>
|
|
263
306
|
<p>Generic key/value(s) options to pass to the microservice. These take the form of KEYWORD/PARAMS like a line in a OpenC3 configuration file. Multiple OPTION keywords can be used to pass multiple options to the microservice.</p>
|
|
264
307
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Option Name</td><td>Name of the option</td><td>True</td></tr><tr><td>Option Value(s)</td><td>One or more values to associate with the option</td><td>True</td></tr></tbody></table>
|
|
265
|
-
<h3
|
|
308
|
+
<h3 id="container-1">CONTAINER</h3>
|
|
266
309
|
<p><strong>Docker Container</strong></p>
|
|
267
310
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
|
|
268
311
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
|
|
269
|
-
<h3
|
|
312
|
+
<h3 id="secret-1">SECRET</h3>
|
|
270
313
|
<p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
|
|
271
314
|
<p>Defines a secret for this microservice</p>
|
|
272
315
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
|
|
273
316
|
<p>Example Usage:</p>
|
|
274
|
-
<
|
|
275
|
-
|
|
317
|
+
<pre><code class="language-ruby">SECRET ENV USERNAME ENV_USERNAME
|
|
318
|
+
SECRET FILE KEY "/tmp/DATA/cert"
|
|
319
|
+
</code></pre>
|
|
320
|
+
<h3 id="route_prefix-1">ROUTE_PREFIX</h3>
|
|
276
321
|
<p></p><div class="right">(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
|
|
277
322
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
278
323
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
|
|
279
324
|
<p>Example Usage:</p>
|
|
280
|
-
<
|
|
281
|
-
|
|
325
|
+
<pre><code class="language-ruby">MICROSERVICE CFDP CFDP
|
|
326
|
+
ROUTE_PREFIX /cfdp
|
|
327
|
+
</code></pre>
|
|
328
|
+
<h3 id="disable_erb-1">DISABLE_ERB</h3>
|
|
282
329
|
<p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
283
330
|
<p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
|
|
284
331
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
|
|
285
|
-
<h2
|
|
332
|
+
<h2 id="tool-1">TOOL</h2>
|
|
286
333
|
<p><strong>Define a tool</strong></p>
|
|
287
334
|
<p>Defines a tool that the plugin adds to the OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices.</p>
|
|
288
335
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Tool Folder Name</td><td>The exact name of the tool folder in the plugin. ie. tools/ToolFolderName</td><td>True</td></tr><tr><td>Tool Name</td><td>Name of the tool that is displayed in the OpenC3 Navigation menu</td><td>True</td></tr></tbody></table>
|
|
289
336
|
<p>Example Usage:</p>
|
|
290
|
-
<
|
|
291
|
-
|
|
337
|
+
<pre><code class="language-ruby">TOOL DEMO Demo
|
|
338
|
+
</code></pre>
|
|
339
|
+
<h2 id="tool-modifiers">TOOL Modifiers</h2>
|
|
292
340
|
<p>The following keywords must follow a TOOL keyword.</p>
|
|
293
|
-
<h3
|
|
341
|
+
<h3 id="url">URL</h3>
|
|
294
342
|
<p><strong>Url used to access the tool</strong></p>
|
|
295
343
|
<p>The relative url used to access the tool. Defaults to "/tools/ToolFolderName".</p>
|
|
296
344
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.</td><td>True</td></tr></tbody></table>
|
|
297
|
-
<h3
|
|
345
|
+
<h3 id="inline_url">INLINE_URL</h3>
|
|
298
346
|
<p><strong>Internal url to load a tool</strong></p>
|
|
299
347
|
<p>The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".</p>
|
|
300
348
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename.</td><td>True</td></tr></tbody></table>
|
|
301
|
-
<h3
|
|
349
|
+
<h3 id="window">WINDOW</h3>
|
|
302
350
|
<p><strong>How to display the tool when navigated to</strong></p>
|
|
303
351
|
<p>The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within OpenC3. NEW opens the tool in a new TAB.</p>
|
|
304
352
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Window Mode</td><td>Tool display mode<br><br>Valid Values: <span class="values">INLINE, IFRAME, NEW</span></td><td>True</td></tr></tbody></table>
|
|
305
|
-
<h3
|
|
353
|
+
<h3 id="icon">ICON</h3>
|
|
306
354
|
<p><strong>Set tool icon</strong></p>
|
|
307
355
|
<p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
|
|
308
|
-
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon Name</td><td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href="https://materialdesignicons.com/"
|
|
309
|
-
<h3
|
|
356
|
+
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon Name</td><td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href="https://materialdesignicons.com/">https://materialdesignicons.com/</a>), and Astro.</td><td>True</td></tr></tbody></table>
|
|
357
|
+
<h3 id="category">CATEGORY</h3>
|
|
310
358
|
<p><strong>Category for the tool</strong></p>
|
|
311
359
|
<p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
|
|
312
360
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Category Name</td><td>Category to associate the tool with</td><td>True</td></tr></tbody></table>
|
|
313
|
-
<h3
|
|
361
|
+
<h3 id="shown">SHOWN</h3>
|
|
314
362
|
<p><strong>Show the tool or not</strong></p>
|
|
315
363
|
<p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
|
|
316
364
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Shown</td><td>Whether or not the tool is shown. TRUE or FALSE<br><br>Valid Values: <span class="values">true, false</span></td><td>True</td></tr></tbody></table>
|
|
317
|
-
<h3
|
|
365
|
+
<h3 id="position">POSITION</h3>
|
|
318
366
|
<p></p><div class="right">(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
|
|
319
367
|
<p>Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed.</p>
|
|
320
368
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Position</td><td>Numerical position</td><td>True</td></tr></tbody></table>
|
|
321
|
-
<h3
|
|
369
|
+
<h3 id="disable_erb-2">DISABLE_ERB</h3>
|
|
322
370
|
<p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
323
371
|
<p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
|
|
324
372
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
|
|
325
|
-
<h2
|
|
373
|
+
<h2 id="widget">WIDGET</h2>
|
|
326
374
|
<p><strong>Define a custom widget</strong></p>
|
|
327
375
|
<p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
|
|
328
376
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Name</td><td>The name of the widget wil be used to build a path to the widget implementation. For example, <code>WIDGET HELLOWORLD</code> will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide for more details.</td><td>True</td></tr></tbody></table>
|
|
329
377
|
<p>Example Usage:</p>
|
|
330
|
-
<
|
|
331
|
-
|
|
378
|
+
<pre><code class="language-ruby">WIDGET HELLOWORLD
|
|
379
|
+
</code></pre>
|
|
380
|
+
<h2 id="widget-modifiers">WIDGET Modifiers</h2>
|
|
332
381
|
<p>The following keywords must follow a WIDGET keyword.</p>
|
|
333
|
-
<h3
|
|
382
|
+
<h3 id="disable_erb-3">DISABLE_ERB</h3>
|
|
334
383
|
<p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
335
384
|
<p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
|
|
336
385
|
<table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.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"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></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/configuration/format"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Targets</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></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></li></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></li></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"></path></svg></a></li></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"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|