openc3-cosmos-tool-docs 6.10.1 → 6.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/css/{styles.9a220ac7.css → styles.6a21a146.css} +1 -1
- data/tools/staticdocs/assets/js/{019369f3.d7bbc5e1.js → 019369f3.622250b4.js} +1 -1
- data/tools/staticdocs/assets/js/{058ffc22.e446ff0d.js → 058ffc22.8edfaac4.js} +1 -1
- data/tools/staticdocs/assets/js/{0686a885.5b4c4b4d.js → 0686a885.9151d3f9.js} +1 -1
- data/tools/staticdocs/assets/js/{078dbab0.656de457.js → 078dbab0.09694602.js} +1 -1
- data/tools/staticdocs/assets/js/{0f5d161c.7e54cdcf.js → 0f5d161c.4c365bfd.js} +1 -1
- data/tools/staticdocs/assets/js/0ff569c9.7a4faa61.js +1 -0
- data/tools/staticdocs/assets/js/{10209fc9.b137dbd6.js → 10209fc9.dc70ea3f.js} +1 -1
- data/tools/staticdocs/assets/js/{103cc3be.ee6acb84.js → 103cc3be.c15dbb1d.js} +1 -1
- data/tools/staticdocs/assets/js/13196248.c70e8c44.js +1 -0
- data/tools/staticdocs/assets/js/{13c1b4e4.4c262e75.js → 13c1b4e4.c29d1c64.js} +1 -1
- data/tools/staticdocs/assets/js/1731.371fb57d.js +1 -0
- data/tools/staticdocs/assets/js/{1c0a0c05.ddb465d3.js → 1c0a0c05.35a848fc.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.6cacf929.js → 2047b354.1fd954bf.js} +1 -1
- data/tools/staticdocs/assets/js/{22b3ac48.7b94bcf3.js → 22b3ac48.9afe5dd8.js} +1 -1
- data/tools/staticdocs/assets/js/26b8abb2.980a3452.js +1 -0
- data/tools/staticdocs/assets/js/{2bb7bf90.3bde2607.js → 2bb7bf90.aa9deeb1.js} +1 -1
- data/tools/staticdocs/assets/js/{2c15ad40.4b4b971e.js → 2c15ad40.5b907671.js} +1 -1
- data/tools/staticdocs/assets/js/3064.05d05a26.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.17c941ac.js +1 -0
- data/tools/staticdocs/assets/js/{3dd7ef3b.0221eef2.js → 3dd7ef3b.60465ff4.js} +1 -1
- data/tools/staticdocs/assets/js/{40365d27.41de4945.js → 40365d27.a658985c.js} +1 -1
- data/tools/staticdocs/assets/js/{411898ad.6f36be2d.js → 411898ad.9843564e.js} +1 -1
- data/tools/staticdocs/assets/js/42170351.0865881a.js +1 -0
- data/tools/staticdocs/assets/js/{43652efd.e2fc7748.js → 43652efd.6c00e2f7.js} +1 -1
- data/tools/staticdocs/assets/js/5191.15b90810.js +1 -0
- data/tools/staticdocs/assets/js/{53ca7c5b.eccd9100.js → 53ca7c5b.576d6c45.js} +1 -1
- data/tools/staticdocs/assets/js/{54d0d530.cec50ece.js → 54d0d530.2278fc39.js} +1 -1
- data/tools/staticdocs/assets/js/{567dad64.50613669.js → 567dad64.89733625.js} +1 -1
- data/tools/staticdocs/assets/js/{5738ba7a.cede7d7a.js → 5738ba7a.c1945cad.js} +1 -1
- data/tools/staticdocs/assets/js/{59ed27a4.1b2efe08.js → 59ed27a4.53f184ee.js} +1 -1
- data/tools/staticdocs/assets/js/{5b233ba7.9faed769.js → 5b233ba7.e3319d37.js} +1 -1
- data/tools/staticdocs/assets/js/{5bc719f6.789ebf64.js → 5bc719f6.2fc3c8f6.js} +1 -1
- data/tools/staticdocs/assets/js/{5c6ce5ec.16226a4e.js → 5c6ce5ec.87929366.js} +1 -1
- data/tools/staticdocs/assets/js/5e3ed378.dcffdeae.js +1 -0
- data/tools/staticdocs/assets/js/{5fe211ef.bfe87c27.js → 5fe211ef.e2df613c.js} +1 -1
- data/tools/staticdocs/assets/js/6317.78aef81b.js +4 -0
- data/tools/staticdocs/assets/js/6321.2b2e50c9.js +101 -0
- data/tools/staticdocs/assets/js/6831b732.5cffcb1b.js +1 -0
- data/tools/staticdocs/assets/js/{696b4199.7520348a.js → 696b4199.e21ac90d.js} +1 -1
- data/tools/staticdocs/assets/js/{6b210247.fc77f080.js → 6b210247.6948ce0a.js} +1 -1
- data/tools/staticdocs/assets/js/{6b65133b.f2b11b07.js → 6b65133b.9a650bf4.js} +1 -1
- data/tools/staticdocs/assets/js/{6f92e431.26f4227b.js → 6f92e431.42d18623.js} +1 -1
- data/tools/staticdocs/assets/js/{72c6d8a8.0b8c5d2f.js → 72c6d8a8.f72ab546.js} +1 -1
- data/tools/staticdocs/assets/js/{75e64983.8112c73c.js → 75e64983.e1b9bc7d.js} +1 -1
- data/tools/staticdocs/assets/js/8330.134a0142.js +1 -0
- data/tools/staticdocs/assets/js/{867640d5.6bc9ed72.js → 867640d5.a8e8538f.js} +1 -1
- data/tools/staticdocs/assets/js/{89e76475.6411e788.js → 89e76475.32c89b40.js} +1 -1
- data/tools/staticdocs/assets/js/{8b939c74.5e039b7a.js → 8b939c74.99379b35.js} +1 -1
- data/tools/staticdocs/assets/js/{8f7843ee.fb130406.js → 8f7843ee.e62c6e1f.js} +1 -1
- data/tools/staticdocs/assets/js/{9424f0b3.90296433.js → 9424f0b3.bf3ec778.js} +1 -1
- data/tools/staticdocs/assets/js/{964eb012.94a1dac1.js → 964eb012.4e5410df.js} +1 -1
- data/tools/staticdocs/assets/js/{97535711.3e76daa6.js → 97535711.b76a8c8c.js} +1 -1
- data/tools/staticdocs/assets/js/{99581c43.48391a19.js → 99581c43.c34f316a.js} +1 -1
- data/tools/staticdocs/assets/js/{9d6e81d0.c9e12517.js → 9d6e81d0.09ec34de.js} +1 -1
- data/tools/staticdocs/assets/js/{9fb6059a.2473a196.js → 9fb6059a.88b86038.js} +1 -1
- data/tools/staticdocs/assets/js/{a677c089.4e7df83d.js → a677c089.08bdd6d4.js} +1 -1
- data/tools/staticdocs/assets/js/{a9987364.5ca31d27.js → a9987364.f143fcf5.js} +1 -1
- data/tools/staticdocs/assets/js/a9b2dc27.307c7457.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.daef5095.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.09ce80e1.js +1 -0
- data/tools/staticdocs/assets/js/{b38a6d74.b0b07b64.js → b38a6d74.00258c8b.js} +1 -1
- data/tools/staticdocs/assets/js/{b4596165.8792340f.js → b4596165.fa18ea16.js} +1 -1
- data/tools/staticdocs/assets/js/b6d70f94.22bbfe27.js +1 -0
- data/tools/staticdocs/assets/js/{b9f60ba6.f2b60175.js → b9f60ba6.f6e2591d.js} +1 -1
- data/tools/staticdocs/assets/js/{bd0034eb.f33ae892.js → bd0034eb.b3071da1.js} +1 -1
- data/tools/staticdocs/assets/js/{c24eae19.4d25de93.js → c24eae19.4d680f8b.js} +1 -1
- data/tools/staticdocs/assets/js/{c956ad1e.38882e03.js → c956ad1e.fa55a414.js} +1 -1
- data/tools/staticdocs/assets/js/{cb8c3f08.7ca03d18.js → cb8c3f08.9d7767a0.js} +1 -1
- data/tools/staticdocs/assets/js/{cd879be4.f77d4fff.js → cd879be4.207fcb79.js} +1 -1
- data/tools/staticdocs/assets/js/cf1c01b8.85934be0.js +1 -0
- data/tools/staticdocs/assets/js/{d1b923aa.a5b3429d.js → d1b923aa.b31315e3.js} +1 -1
- data/tools/staticdocs/assets/js/d1bfc316.16fb4147.js +1 -0
- data/tools/staticdocs/assets/js/{d24bf9b6.f380debf.js → d24bf9b6.c8d15feb.js} +1 -1
- data/tools/staticdocs/assets/js/{d57a4b5d.7ce9d24e.js → d57a4b5d.90256479.js} +1 -1
- data/tools/staticdocs/assets/js/{d59d8a14.41f22286.js → d59d8a14.2ecf6a7b.js} +1 -1
- data/tools/staticdocs/assets/js/d5d77c37.1de06b83.js +1 -0
- data/tools/staticdocs/assets/js/{d66bf9c0.c87e9dc0.js → d66bf9c0.be6ef286.js} +1 -1
- data/tools/staticdocs/assets/js/{d8ca4191.b24de36d.js → d8ca4191.4cf3e03b.js} +1 -1
- data/tools/staticdocs/assets/js/d9b92eba.13b9d3a8.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.0714f6fa.js +1 -0
- data/tools/staticdocs/assets/js/{dbe31111.4f18bf2b.js → dbe31111.ae534424.js} +1 -1
- data/tools/staticdocs/assets/js/{dc5f7beb.d439e98e.js → dc5f7beb.28bc7f0f.js} +1 -1
- data/tools/staticdocs/assets/js/{e501b0d1.e7e284e5.js → e501b0d1.9b902145.js} +1 -1
- data/tools/staticdocs/assets/js/{f15615f1.7dcf0c73.js → f15615f1.7835e26e.js} +1 -1
- data/tools/staticdocs/assets/js/{f75a5f33.a7c7ff1d.js → f75a5f33.8fcf0643.js} +1 -1
- data/tools/staticdocs/assets/js/fd886806.efd66dbe.js +1 -0
- data/tools/staticdocs/assets/js/{main.81fa15db.js → main.355b79aa.js} +6 -6
- data/tools/staticdocs/assets/js/{runtime~main.e35f5fea.js → runtime~main.4a381777.js} +1 -1
- data/tools/staticdocs/docs/configuration/accessors.html +46 -46
- data/tools/staticdocs/docs/configuration/command.html +87 -87
- data/tools/staticdocs/docs/configuration/conversions.html +47 -47
- data/tools/staticdocs/docs/configuration/format.html +21 -21
- data/tools/staticdocs/docs/configuration/interfaces.html +55 -55
- data/tools/staticdocs/docs/configuration/limits-response.html +10 -10
- data/tools/staticdocs/docs/configuration/plugins.html +129 -124
- data/tools/staticdocs/docs/configuration/processors.html +15 -15
- data/tools/staticdocs/docs/configuration/protocols.html +66 -66
- data/tools/staticdocs/docs/configuration/ssl-tls.html +15 -15
- data/tools/staticdocs/docs/configuration/table.html +44 -44
- data/tools/staticdocs/docs/configuration/target.html +21 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +253 -253
- data/tools/staticdocs/docs/configuration/telemetry.html +83 -83
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +14 -14
- data/tools/staticdocs/docs/development/developing.html +16 -16
- data/tools/staticdocs/docs/development/json-api.html +15 -15
- data/tools/staticdocs/docs/development/log-structure.html +11 -11
- data/tools/staticdocs/docs/development/roadmap.html +4 -4
- data/tools/staticdocs/docs/development/streaming-api.html +24 -24
- data/tools/staticdocs/docs/development/testing.html +17 -17
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/cli.html +42 -42
- data/tools/staticdocs/docs/getting-started/generators.html +24 -24
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
- data/tools/staticdocs/docs/getting-started/installation.html +49 -19
- data/tools/staticdocs/docs/getting-started/key-concepts.html +20 -20
- data/tools/staticdocs/docs/getting-started/podman.html +23 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
- data/tools/staticdocs/docs/getting-started/upgrading.html +44 -44
- data/tools/staticdocs/docs/getting-started/util.html +25 -25
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +14 -14
- data/tools/staticdocs/docs/guides/cfs.html +32 -32
- data/tools/staticdocs/docs/guides/custom-widgets.html +33 -33
- data/tools/staticdocs/docs/guides/dynamic-packets.html +7 -6
- data/tools/staticdocs/docs/guides/exposing-microservices.html +11 -11
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +4 -4
- data/tools/staticdocs/docs/guides/local-mode.html +13 -13
- data/tools/staticdocs/docs/guides/logging.html +9 -9
- data/tools/staticdocs/docs/guides/monitoring.html +18 -18
- data/tools/staticdocs/docs/guides/performance.html +10 -10
- data/tools/staticdocs/docs/guides/raspberrypi.html +4 -4
- data/tools/staticdocs/docs/guides/reference-architectures.html +6 -6
- data/tools/staticdocs/docs/guides/roles-permissions.html +29 -29
- data/tools/staticdocs/docs/guides/script-writing.html +75 -68
- data/tools/staticdocs/docs/guides/scripting-api.html +672 -667
- data/tools/staticdocs/docs/guides/troubleshooting.html +7 -7
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +12 -12
- data/tools/staticdocs/docs/meta/licenses.html +9 -9
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/vulnerabilities.html +5 -5
- data/tools/staticdocs/docs/meta/xtce.html +12 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/admin.html +28 -28
- data/tools/staticdocs/docs/tools/autonomic.html +19 -19
- data/tools/staticdocs/docs/tools/bucket-explorer.html +11 -11
- data/tools/staticdocs/docs/tools/calendar.html +24 -24
- data/tools/staticdocs/docs/tools/cmd-sender.html +13 -13
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +24 -24
- data/tools/staticdocs/docs/tools/command-history.html +6 -6
- data/tools/staticdocs/docs/tools/command-queue.html +8 -8
- data/tools/staticdocs/docs/tools/data-extractor.html +23 -23
- data/tools/staticdocs/docs/tools/data-viewer.html +10 -10
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +15 -15
- data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/packet-viewer.html +10 -10
- data/tools/staticdocs/docs/tools/script-runner.html +36 -36
- data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
- data/tools/staticdocs/docs/tools/table-manager.html +10 -10
- 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 +11 -11
- data/tools/staticdocs/index.html +2 -2
- data/tools/staticdocs/lunr-index-1765917283926.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1765917283926.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +92 -92
- data/tools/staticdocs/assets/js/0ff569c9.9566d390.js +0 -1
- data/tools/staticdocs/assets/js/1202.d22d6899.js +0 -101
- data/tools/staticdocs/assets/js/13196248.8bbc13cd.js +0 -1
- data/tools/staticdocs/assets/js/1596.e0bc0cb8.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.237c47e9.js +0 -1
- data/tools/staticdocs/assets/js/3140.8b312c79.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.0f3180d9.js +0 -1
- data/tools/staticdocs/assets/js/42170351.3618f599.js +0 -1
- data/tools/staticdocs/assets/js/4581.bbe04eae.js +0 -4
- data/tools/staticdocs/assets/js/5e3ed378.9ad2dcd2.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.1790429a.js +0 -1
- data/tools/staticdocs/assets/js/7399.857e78fe.js +0 -1
- data/tools/staticdocs/assets/js/9601.e8389133.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.1f8d5c81.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.750dc927.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.cd8e5784.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.43a5cd5a.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.f5a9a237.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.7c605bc5.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.ae6fba94.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.b08eeda4.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.a05e2bae.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.4b383c00.js +0 -1
- data/tools/staticdocs/lunr-index-1765340262146.json +0 -1
- data/tools/staticdocs/search-doc-1765340262146.json +0 -1
|
@@ -1,354 +1,359 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/plugins" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.2"><title data-rh=true>Plugins | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/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="Plugin definition file format and keywords"/><meta data-rh=true property=og:description content="Plugin definition file format and keywords"/><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 /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins","name":"Plugins","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/plugins" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.2"><title data-rh=true>Plugins | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/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="Plugin definition file format and keywords"/><meta data-rh=true property=og:description content="Plugin definition file format and keywords"/><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 /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins","name":"Plugins","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.6a21a146.css /><script src=/tools/staticdocs/assets/js/runtime~main.4a381777.js defer></script><script src=/tools/staticdocs/assets/js/main.355b79aa.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><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"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
|
-
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_o0fc href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_rL1b themedComponent--light_Jjpb"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_rL1b themedComponent--dark_iTVY"/></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="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_kyQG><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="theme-layout-main main-wrapper mainWrapper_WiXA"><div class=docsWrapper_oxIj><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_EO3c" type=button></button><div class=docRoot_hMsS><aside class="theme-doc-sidebar-container docSidebarContainer_DuYd"><div class=sidebarViewport_m2O2><div class=sidebar_gO6z><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_sODH"><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><span title=Introduction class=linkLabel_ruxY>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_VDQ2>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_VDQ2>Configuration</span></a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul 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><span title="File Format" class=linkLabel_ruxY>File Format</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/plugins><span title=Plugins class=linkLabel_ruxY>Plugins</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target><span title=Targets class=linkLabel_ruxY>Targets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command><span title=Commands class=linkLabel_ruxY>Commands</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry><span title=Telemetry class=linkLabel_ruxY>Telemetry</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces><span title=Interfaces class=linkLabel_ruxY>Interfaces</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols><span title=Protocols class=linkLabel_ruxY>Protocols</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors><span title=Accessors class=linkLabel_ruxY>Accessors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions><span title=Conversions class=linkLabel_ruxY>Conversions</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/processors><span title=Processors class=linkLabel_ruxY>Processors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/limits-response><span title="Limits Response" class=linkLabel_ruxY>Limits Response</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table><span title=Tables class=linkLabel_ruxY>Tables</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens><span title=Screens class=linkLabel_ruxY>Screens</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls><span title=SSL-TLS class=linkLabel_ruxY>SSL-TLS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_VDQ2>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_VDQ2>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_VDQ2>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_OZsf menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_VDQ2>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_ruxY>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_nOYO><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_r8QP"><div class=docItemContainer_rPX_><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_xF7v" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_K3oZ><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Plugins</span></ul></nav><div class="tocCollapsible_R7Xp theme-doc-toc-mobile tocMobile_efly"><button type=button class="clean-btn tocCollapsibleButton_HWoo">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 class="anchor anchorTargetStickyNavbar_TTTW" id=introduction>Introduction<a href=#introduction class=hash-link aria-label="Direct link to Introduction" title="Direct link to Introduction" translate=no></a></h2>
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_scQT href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_qpJx themedComponent--light_BioS"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_qpJx themedComponent--dark_DgAM"/></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="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer__giP><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="theme-layout-main main-wrapper mainWrapper_qUE_"><div class=docsWrapper_ObNm><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_xm72" type=button></button><div class=docRoot_ItuS><aside class="theme-doc-sidebar-container docSidebarContainer_HmQ6"><div class=sidebarViewport_DwNg><div class=sidebar_oy8c><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_EL20"><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><span title=Introduction class=linkLabel_OLaQ>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_TqXL>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_TqXL>Configuration</span></a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul 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><span title="File Format" class=linkLabel_OLaQ>File Format</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/plugins><span title=Plugins class=linkLabel_OLaQ>Plugins</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target><span title=Targets class=linkLabel_OLaQ>Targets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command><span title=Commands class=linkLabel_OLaQ>Commands</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry><span title=Telemetry class=linkLabel_OLaQ>Telemetry</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces><span title=Interfaces class=linkLabel_OLaQ>Interfaces</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols><span title=Protocols class=linkLabel_OLaQ>Protocols</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors><span title=Accessors class=linkLabel_OLaQ>Accessors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions><span title=Conversions class=linkLabel_OLaQ>Conversions</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/processors><span title=Processors class=linkLabel_OLaQ>Processors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/limits-response><span title="Limits Response" class=linkLabel_OLaQ>Limits Response</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table><span title=Tables class=linkLabel_OLaQ>Tables</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens><span title=Screens class=linkLabel_OLaQ>Screens</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls><span title=SSL-TLS class=linkLabel_OLaQ>SSL-TLS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_TqXL>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_TqXL>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_TqXL>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_ElYC menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_TqXL>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_OLaQ>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Fwt6><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_MSuJ"><div class=docItemContainer_f5Ax><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_qWB9" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_rfH6><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Plugins</span></ul></nav><div class="tocCollapsible_nDBa theme-doc-toc-mobile tocMobile_LsDa"><button type=button class="clean-btn tocCollapsibleButton_R5Nl">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=introduction>Introduction<a href=#introduction class=hash-link aria-label="Direct link to Introduction" title="Direct link to Introduction" translate=no></a></h2>
|
|
5
5
|
<p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
|
|
6
|
-
<p>Plugins are where you define
|
|
6
|
+
<p>Plugins are where you define <a class="" href=/tools/staticdocs/docs/configuration/target>Targets</a> (and their corresponding command and telemetry packet definitions), <a class="" href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> needed to talk to targets, <a class="" href=/tools/staticdocs/docs/configuration/interfaces>Routers</a> to stream raw data out of COSMOS, Microservices to provide new functionality, Widgets and Tools to add new GUIs, and Script Engines to implement custom script languages.</p>
|
|
7
|
+
<p>Plugin <a class="" href=/tools/staticdocs/docs/configuration/target>Targets</a> must be installed (or re-installed) to update commands, telemetry, conversions, limits responses, microservices, and anything that changes the structure of a packet or contains code (conversions, limits responses, etc). Certain aspects of a Target can be changed through APIs like limits but most require reinstalling the Target. Note that COSMOS also supports <a class="" href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a> but this is meant for use during COSMOS plugin initialization rather than while running.</p>
|
|
7
8
|
<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>
|
|
8
|
-
<h2 class="anchor
|
|
9
|
-
<h3 class="anchor
|
|
9
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=concepts>Concepts<a href=#concepts class=hash-link aria-label="Direct link to Concepts" title="Direct link to Concepts" translate=no></a></h2>
|
|
10
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=target>Target<a href=#target class=hash-link aria-label="Direct link to Target" title="Direct link to Target" translate=no></a></h3>
|
|
10
11
|
<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>
|
|
11
|
-
<h3 class="anchor
|
|
12
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=interface>Interface<a href=#interface class=hash-link aria-label="Direct link to Interface" title="Direct link to Interface" translate=no></a></h3>
|
|
12
13
|
<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>
|
|
13
|
-
<h3 class="anchor
|
|
14
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=router>Router<a href=#router class=hash-link aria-label="Direct link to Router" title="Direct link to Router" translate=no></a></h3>
|
|
14
15
|
<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>
|
|
15
|
-
<h3 class="anchor
|
|
16
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=widgets>Widgets<a href=#widgets class=hash-link aria-label="Direct link to Widgets" title="Direct link to Widgets" translate=no></a></h3>
|
|
17
|
+
<p>COSMOS Widgets are GUI elements that can be placed on <a class="" href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a> in <a class="" href=/tools/staticdocs/docs/tools/tlm-viewer>Telemetry Viewer</a>.</p>
|
|
18
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tool>Tool<a href=#tool class=hash-link aria-label="Direct link to Tool" title="Direct link to Tool" translate=no></a></h3>
|
|
16
19
|
<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>
|
|
17
|
-
<h3 class="anchor
|
|
20
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=microservice>Microservice<a href=#microservice class=hash-link aria-label="Direct link to Microservice" title="Direct link to Microservice" translate=no></a></h3>
|
|
18
21
|
<p>Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks.</p>
|
|
19
|
-
<
|
|
22
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=script-engines>Script Engines<a href=#script-engines class=hash-link aria-label="Direct link to Script Engines" title="Direct link to Script Engines" translate=no></a></h3>
|
|
23
|
+
<p>Script Engines enhance Script Runner by providing the implementation of a new file type and language. The new language must be implemented in either Ruby or Python but can support any custom Domain Specific Language (DSL). For a real example see our <a href=https://github.com/OpenC3/openc3-cosmos-script-engine-cstol target=_blank rel="noopener noreferrer" class="">CSTOL</a> implementation.</p>
|
|
24
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=plugin-directory-structure>Plugin Directory Structure<a href=#plugin-directory-structure class=hash-link aria-label="Direct link to Plugin Directory Structure" title="Direct link to Plugin Directory Structure" translate=no></a></h2>
|
|
20
25
|
<p>COSMOS plugins have a well-defined directory structure described in detail in the <a class="" href=/tools/staticdocs/docs/getting-started/generators>Code Generator</a> documentation.</p>
|
|
21
|
-
<h2 class="anchor
|
|
26
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=plugintxt-configuration-file>plugin.txt Configuration File<a href=#plugintxt-configuration-file class=hash-link aria-label="Direct link to plugin.txt Configuration File" title="Direct link to plugin.txt Configuration File" translate=no></a></h2>
|
|
22
27
|
<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.
|
|
23
28
|
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>
|
|
24
|
-
<h2 class="anchor
|
|
29
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=variable>VARIABLE<a href=#variable class=hash-link aria-label="Direct link to VARIABLE" title="Direct link to VARIABLE" translate=no></a></h2>
|
|
25
30
|
<p><strong>Define a configurable variable for the plugin</strong></p>
|
|
26
31
|
<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>
|
|
27
32
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Variable Name<td>The name of the variable<td>True<tr><td>Default Value<td>Default value of the variable<td>True</table>
|
|
28
|
-
<h2 class="anchor
|
|
33
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=needs_dependencies>NEEDS_DEPENDENCIES<a href=#needs_dependencies class=hash-link aria-label="Direct link to NEEDS_DEPENDENCIES" title="Direct link to NEEDS_DEPENDENCIES" translate=no></a></h2>
|
|
29
34
|
<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>
|
|
30
35
|
<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, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kubernetes pod.</p>
|
|
31
|
-
<h2 class="anchor
|
|
36
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=interface-1>INTERFACE<a href=#interface-1 class=hash-link aria-label="Direct link to INTERFACE" title="Direct link to INTERFACE" translate=no></a></h2>
|
|
32
37
|
<p><strong>Defines a connection to a physical target</strong></p>
|
|
33
38
|
<p>Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby or Python 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>
|
|
34
39
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Interface Name<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>True<tr><td>Filename<td>Ruby or Python file to use when instantiating the interface.<br/><br/>Valid Values: <span class=values>tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span><td>True</table>
|
|
35
40
|
<p>Additional parameters are required. Please see the <a class="" href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
|
|
36
|
-
<h2 class="anchor
|
|
41
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=interface-modifiers>INTERFACE Modifiers<a href=#interface-modifiers class=hash-link aria-label="Direct link to INTERFACE Modifiers" title="Direct link to INTERFACE Modifiers" translate=no></a></h2>
|
|
37
42
|
<p>The following keywords must follow a INTERFACE keyword.</p>
|
|
38
|
-
<h3 class="anchor
|
|
43
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=map_target>MAP_TARGET<a href=#map_target class=hash-link aria-label="Direct link to MAP_TARGET" title="Direct link to MAP_TARGET" translate=no></a></h3>
|
|
39
44
|
<p><strong>Maps a target name to an interface</strong></p>
|
|
40
45
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target name to map to this interface<td>True</table>
|
|
41
|
-
<div class="theme-tabs-container tabs-container
|
|
42
|
-
<h3 class="anchor
|
|
46
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE DATA_INT openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> nil BURST</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TARGET DATA</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><br/></span></code></pre></div></div></div></div></div>
|
|
47
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=map_cmd_target>MAP_CMD_TARGET<a href=#map_cmd_target class=hash-link aria-label="Direct link to MAP_CMD_TARGET" title="Direct link to MAP_CMD_TARGET" translate=no></a></h3>
|
|
43
48
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
|
|
44
49
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Command target name to map to this interface<td>True</table>
|
|
45
|
-
<div class="theme-tabs-container tabs-container
|
|
46
|
-
<h3 class="anchor
|
|
50
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE CMD_INT openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> nil BURST</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_CMD_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CMD_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_CMD_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</span><br/></span></code></pre></div></div></div></div></div>
|
|
51
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=map_tlm_target>MAP_TLM_TARGET<a href=#map_tlm_target class=hash-link aria-label="Direct link to MAP_TLM_TARGET" title="Direct link to MAP_TLM_TARGET" translate=no></a></h3>
|
|
47
52
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
|
|
48
53
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Telemetry target name to map to this interface<td>True</table>
|
|
49
|
-
<div class="theme-tabs-container tabs-container
|
|
50
|
-
<h3 class="anchor
|
|
54
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE TLM_INT openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> nil BURST</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TLM_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TLM_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TLM_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</span><br/></span></code></pre></div></div></div></div></div>
|
|
55
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=dont_connect>DONT_CONNECT<a href=#dont_connect class=hash-link aria-label="Direct link to DONT_CONNECT" title="Direct link to DONT_CONNECT" translate=no></a></h3>
|
|
51
56
|
<p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
|
|
52
|
-
<h3 class="anchor
|
|
57
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=dont_reconnect>DONT_RECONNECT<a href=#dont_reconnect class=hash-link aria-label="Direct link to DONT_RECONNECT" title="Direct link to DONT_RECONNECT" translate=no></a></h3>
|
|
53
58
|
<p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
|
|
54
|
-
<h3 class="anchor
|
|
59
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reconnect_delay>RECONNECT_DELAY<a href=#reconnect_delay class=hash-link aria-label="Direct link to RECONNECT_DELAY" title="Direct link to RECONNECT_DELAY" translate=no></a></h3>
|
|
55
60
|
<p><strong>Reconnect delay in seconds</strong></p>
|
|
56
61
|
<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>
|
|
57
62
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Delay<td>Delay in seconds between reconnect attempts. The default is 15 seconds.<td>True</table>
|
|
58
|
-
<h3 class="anchor
|
|
63
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=disable_disconnect>DISABLE_DISCONNECT<a href=#disable_disconnect class=hash-link aria-label="Direct link to DISABLE_DISCONNECT" title="Direct link to DISABLE_DISCONNECT" translate=no></a></h3>
|
|
59
64
|
<p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
|
|
60
65
|
<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 inadvertently disconnect from a target.</p>
|
|
61
|
-
<h3 class="anchor
|
|
66
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=log_raw>LOG_RAW<a href=#log_raw class=hash-link aria-label="Direct link to LOG_RAW" title="Direct link to LOG_RAW" translate=no></a></h3>
|
|
62
67
|
<p><strong>Deprecated, use LOG_STREAM</strong></p>
|
|
63
|
-
<h3 class="anchor
|
|
68
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=log_stream>LOG_STREAM<a href=#log_stream class=hash-link aria-label="Direct link to LOG_STREAM" title="Direct link to LOG_STREAM" translate=no></a></h3>
|
|
64
69
|
<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>
|
|
65
70
|
<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>
|
|
66
71
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Cycle Time<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>False<tr><td>Cycle Size<td>Amount of data to write before cycling the log file. Default is 50MB.<td>False<tr><td>Cycle Hour<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>False<tr><td>Cycle Minute<td>See Cycle Hour.<td>False</table>
|
|
67
72
|
<p>Example Usage:</p>
|
|
68
|
-
<div class="language-ruby
|
|
69
|
-
<h3 class="anchor
|
|
73
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> example_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Override the default log time of 600</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LOG_STREAM</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">60</span><br/></span></code></pre></div></div>
|
|
74
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=protocol>PROTOCOL<a href=#protocol class=hash-link aria-label="Direct link to PROTOCOL" title="Direct link to PROTOCOL" translate=no></a></h3>
|
|
70
75
|
<p><div class=right>(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
|
|
71
76
|
<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 class="" href=/tools/staticdocs/docs/configuration/protocols>Protocols</a></p>
|
|
72
77
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<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>True<tr><td>Protocol Filename or Classname<td>Ruby or Python filename or class name which implements the protocol<td>True<tr><td>Protocol specific parameters<td>Additional parameters used by the protocol<td>False</table>
|
|
73
|
-
<div class="theme-tabs-container tabs-container
|
|
74
|
-
<h3 class="anchor
|
|
78
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE DATA_INT openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> nil BURST</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TARGET DATA</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ignore_packet_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py INST IMAGE </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Drop all INST IMAGE packets</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Rather than defining the LENGTH protocol on the INTERFACE line we define it here</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> LengthProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><br/></span></code></pre></div></div></div></div></div>
|
|
79
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=option>OPTION<a href=#option class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION" translate=no></a></h3>
|
|
75
80
|
<p><strong>Set a parameter on an interface</strong></p>
|
|
76
81
|
<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>
|
|
77
82
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<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 and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).<td>True<tr><td>Parameters<td>Parameters to pass to the option<td>False</table>
|
|
78
83
|
<p>Example Usage:</p>
|
|
79
|
-
<div class="language-ruby
|
|
80
|
-
<h3 class="anchor
|
|
84
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_INT</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOW_CONTROL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RTSCTS</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA_BITS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">ROUTER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_ROUTER</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ROUTE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_INT</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LISTEN_ADDRESS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">127.0</span><span class="token number" style="color:rgb(247, 140, 108)">.0</span><span class="token number" style="color:rgb(247, 140, 108)">.1</span><br/></span></code></pre></div></div>
|
|
85
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=secret>SECRET<a href=#secret class=hash-link aria-label="Direct link to SECRET" title="Direct link to SECRET" translate=no></a></h3>
|
|
81
86
|
<p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
|
|
82
87
|
<p>Defines a secret for this interface and optionally assigns its value to an option. For more information see <a class="" href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
|
|
83
88
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.<td>True<tr><td>Secret Name<td>The name of the secret to retrieve from the Admin / Secrets tab. For more information see <a class="" href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.<td>True<tr><td>Environment Variable or File Path<td>Environment variable name or file path to store secret. Note that if you use the Option Name to set an option to the secret value, this value doesn't really matter as long as it is unique.<td>True<tr><td>Option Name<td>Interface option to pass the secret value. This is the primary way to pass secrets to interfaces.<td>False<tr><td>Secret Store Name<td>Name of the secret store for stores with multipart keys<td>False</table>
|
|
84
89
|
<p>Example Usage:</p>
|
|
85
|
-
<div class="language-ruby
|
|
86
|
-
<h3 class="anchor
|
|
90
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"/tmp/DATA/cert"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><br/></span></code></pre></div></div>
|
|
91
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=env>ENV<a href=#env class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV" translate=no></a></h3>
|
|
87
92
|
<p><div class=right>(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
|
|
88
93
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>Environment variable name<td>True<tr><td>Value<td>Environment variable value<td>True</table>
|
|
89
94
|
<p>Example Usage:</p>
|
|
90
|
-
<div class="language-ruby
|
|
91
|
-
<h3 class="anchor
|
|
95
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</span><br/></span></code></pre></div></div>
|
|
96
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=work_dir>WORK_DIR<a href=#work_dir class=hash-link aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR" translate=no></a></h3>
|
|
92
97
|
<p><div class=right>(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
|
|
93
98
|
<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>
|
|
94
99
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Directory<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>True</table>
|
|
95
100
|
<p>Example Usage:</p>
|
|
96
|
-
<div class="language-ruby
|
|
97
|
-
<h3 class="anchor
|
|
101
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">WORK_DIR</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'/openc3/lib/openc3/microservices'</span><br/></span></code></pre></div></div>
|
|
102
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=port>PORT<a href=#port class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT" translate=no></a></h3>
|
|
98
103
|
<p><div class=right>(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
|
|
99
104
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
100
105
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Number<td>Port number<td>True<tr><td>Protocol<td>Port protocol. Default is TCP.<td>False</table>
|
|
101
106
|
<p>Example Usage:</p>
|
|
102
|
-
<div class="language-ruby
|
|
103
|
-
<h3 class="anchor
|
|
107
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</span><br/></span></code></pre></div></div>
|
|
108
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd>CMD<a href=#cmd class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD" translate=no></a></h3>
|
|
104
109
|
<p><div class=right>(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
|
|
105
110
|
<p>Command line to execute to run the microservice.</p>
|
|
106
111
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>One or more arguments to exec to run the microservice.<td>True</table>
|
|
107
|
-
<div class="theme-tabs-container tabs-container
|
|
108
|
-
<h3 class="anchor
|
|
112
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">CMD python interface_microservice</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py DEFAULT__INTERFACE__INT1</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">CMD</span><span class="token plain"> ruby interface_microservice</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT__INTERFACE__INT1</span><br/></span></code></pre></div></div></div></div></div>
|
|
113
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=container>CONTAINER<a href=#container class=hash-link aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER" translate=no></a></h3>
|
|
109
114
|
<p><div class=right>(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
|
|
110
115
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise.</p>
|
|
111
116
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>Name of the container<td>False</table>
|
|
112
|
-
<h3 class="anchor
|
|
117
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=route_prefix>ROUTE_PREFIX<a href=#route_prefix class=hash-link aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX" translate=no></a></h3>
|
|
113
118
|
<p><div class=right>(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
|
|
114
119
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
115
120
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Route Prefix<td>Route prefix. Must be unique across all scopes. Something like /myprefix<td>True</table>
|
|
116
121
|
<p>Example Usage:</p>
|
|
117
|
-
<div class="language-ruby
|
|
118
|
-
<h3 class="anchor
|
|
122
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interface</span><br/></span></code></pre></div></div>
|
|
123
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=shard>SHARD<a href=#shard class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD" translate=no></a></h3>
|
|
119
124
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
120
125
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
121
126
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
122
127
|
<p>Example Usage:</p>
|
|
123
|
-
<div class="language-ruby
|
|
124
|
-
<h2 class="anchor
|
|
128
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><br/></span></code></pre></div></div>
|
|
129
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=router-1>ROUTER<a href=#router-1 class=hash-link aria-label="Direct link to ROUTER" title="Direct link to ROUTER" translate=no></a></h2>
|
|
125
130
|
<p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
|
|
126
131
|
<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>
|
|
127
132
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the router<td>True<tr><td>Filename<td>Ruby or Python file to use when instantiating the interface.<br/><br/>Valid Values: <span class=values>tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span><td>True</table>
|
|
128
133
|
<p>Additional parameters are required. Please see the <a class="" href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
|
|
129
|
-
<h2 class="anchor
|
|
134
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=target-1>TARGET<a href=#target-1 class=hash-link aria-label="Direct link to TARGET" title="Direct link to TARGET" translate=no></a></h2>
|
|
130
135
|
<p><strong>Defines a new target</strong></p>
|
|
131
136
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Folder Name<td>The target folder<td>True<tr><td>Name<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>True</table>
|
|
132
137
|
<p>Example Usage:</p>
|
|
133
|
-
<div class="language-ruby
|
|
134
|
-
<h2 class="anchor
|
|
138
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><br/></span></code></pre></div></div>
|
|
139
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=target-modifiers>TARGET Modifiers<a href=#target-modifiers class=hash-link aria-label="Direct link to TARGET Modifiers" title="Direct link to TARGET Modifiers" translate=no></a></h2>
|
|
135
140
|
<p>The following keywords must follow a TARGET keyword.</p>
|
|
136
|
-
<h3 class="anchor
|
|
141
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_buffer_depth>CMD_BUFFER_DEPTH<a href=#cmd_buffer_depth class=hash-link aria-label="Direct link to CMD_BUFFER_DEPTH" title="Direct link to CMD_BUFFER_DEPTH" translate=no></a></h3>
|
|
137
142
|
<p><div class=right>(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
|
|
138
143
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Buffer Depth<td>Buffer depth in packets (Default = 5)<td>True</table>
|
|
139
|
-
<h3 class="anchor
|
|
144
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_log_cycle_time>CMD_LOG_CYCLE_TIME<a href=#cmd_log_cycle_time class=hash-link aria-label="Direct link to CMD_LOG_CYCLE_TIME" title="Direct link to CMD_LOG_CYCLE_TIME" translate=no></a></h3>
|
|
140
145
|
<p><strong>Command binary logs can be cycled on a time interval.</strong></p>
|
|
141
146
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
|
|
142
|
-
<h3 class="anchor
|
|
147
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_log_cycle_size>CMD_LOG_CYCLE_SIZE<a href=#cmd_log_cycle_size class=hash-link aria-label="Direct link to CMD_LOG_CYCLE_SIZE" title="Direct link to CMD_LOG_CYCLE_SIZE" translate=no></a></h3>
|
|
143
148
|
<p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
144
149
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
|
|
145
|
-
<h3 class="anchor
|
|
150
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_log_retain_time>CMD_LOG_RETAIN_TIME<a href=#cmd_log_retain_time class=hash-link aria-label="Direct link to CMD_LOG_RETAIN_TIME" title="Direct link to CMD_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
146
151
|
<p><strong>How long to keep raw command logs in seconds.</strong></p>
|
|
147
152
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep raw command logs (default = nil = Forever)<td>True</table>
|
|
148
|
-
<h3 class="anchor
|
|
153
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_decom_log_cycle_time>CMD_DECOM_LOG_CYCLE_TIME<a href=#cmd_decom_log_cycle_time class=hash-link aria-label="Direct link to CMD_DECOM_LOG_CYCLE_TIME" title="Direct link to CMD_DECOM_LOG_CYCLE_TIME" translate=no></a></h3>
|
|
149
154
|
<p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
|
|
150
155
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
|
|
151
|
-
<h3 class="anchor
|
|
156
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_decom_log_cycle_size>CMD_DECOM_LOG_CYCLE_SIZE<a href=#cmd_decom_log_cycle_size class=hash-link aria-label="Direct link to CMD_DECOM_LOG_CYCLE_SIZE" title="Direct link to CMD_DECOM_LOG_CYCLE_SIZE" translate=no></a></h3>
|
|
152
157
|
<p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
153
158
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
|
|
154
|
-
<h3 class="anchor
|
|
159
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd_decom_log_retain_time>CMD_DECOM_LOG_RETAIN_TIME<a href=#cmd_decom_log_retain_time class=hash-link aria-label="Direct link to CMD_DECOM_LOG_RETAIN_TIME" title="Direct link to CMD_DECOM_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
155
160
|
<p><strong>How long to keep decom command logs in seconds.</strong></p>
|
|
156
161
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep decom command logs (default = nil = Forever)<td>True</table>
|
|
157
|
-
<h3 class="anchor
|
|
162
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_buffer_depth>TLM_BUFFER_DEPTH<a href=#tlm_buffer_depth class=hash-link aria-label="Direct link to TLM_BUFFER_DEPTH" title="Direct link to TLM_BUFFER_DEPTH" translate=no></a></h3>
|
|
158
163
|
<p><div class=right>(Since 5.2.0)</div><strong>Number of telemetry packets to buffer to ensure logged in order</strong><p></p>
|
|
159
164
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Buffer Depth<td>Buffer depth in packets (Default = 60)<td>True</table>
|
|
160
|
-
<h3 class="anchor
|
|
165
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_log_cycle_time>TLM_LOG_CYCLE_TIME<a href=#tlm_log_cycle_time class=hash-link aria-label="Direct link to TLM_LOG_CYCLE_TIME" title="Direct link to TLM_LOG_CYCLE_TIME" translate=no></a></h3>
|
|
161
166
|
<p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
|
|
162
167
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
|
|
163
|
-
<h3 class="anchor
|
|
168
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_log_cycle_size>TLM_LOG_CYCLE_SIZE<a href=#tlm_log_cycle_size class=hash-link aria-label="Direct link to TLM_LOG_CYCLE_SIZE" title="Direct link to TLM_LOG_CYCLE_SIZE" translate=no></a></h3>
|
|
164
169
|
<p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
165
170
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
|
|
166
|
-
<h3 class="anchor
|
|
171
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_log_retain_time>TLM_LOG_RETAIN_TIME<a href=#tlm_log_retain_time class=hash-link aria-label="Direct link to TLM_LOG_RETAIN_TIME" title="Direct link to TLM_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
167
172
|
<p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
|
|
168
173
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep raw telemetry logs (default = nil = Forever)<td>True</table>
|
|
169
|
-
<h3 class="anchor
|
|
174
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_decom_log_cycle_time>TLM_DECOM_LOG_CYCLE_TIME<a href=#tlm_decom_log_cycle_time class=hash-link aria-label="Direct link to TLM_DECOM_LOG_CYCLE_TIME" title="Direct link to TLM_DECOM_LOG_CYCLE_TIME" translate=no></a></h3>
|
|
170
175
|
<p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
|
|
171
176
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
|
|
172
|
-
<h3 class="anchor
|
|
177
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_decom_log_cycle_size>TLM_DECOM_LOG_CYCLE_SIZE<a href=#tlm_decom_log_cycle_size class=hash-link aria-label="Direct link to TLM_DECOM_LOG_CYCLE_SIZE" title="Direct link to TLM_DECOM_LOG_CYCLE_SIZE" translate=no></a></h3>
|
|
173
178
|
<p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
174
179
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
|
|
175
|
-
<h3 class="anchor
|
|
180
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=tlm_decom_log_retain_time>TLM_DECOM_LOG_RETAIN_TIME<a href=#tlm_decom_log_retain_time class=hash-link aria-label="Direct link to TLM_DECOM_LOG_RETAIN_TIME" title="Direct link to TLM_DECOM_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
176
181
|
<p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
|
|
177
182
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep decom telemetry logs (default = nil = Forever)<td>True</table>
|
|
178
|
-
<h3 class="anchor
|
|
183
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reduced_minute_log_retain_time>REDUCED_MINUTE_LOG_RETAIN_TIME<a href=#reduced_minute_log_retain_time class=hash-link aria-label="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME" title="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
179
184
|
<p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
|
|
180
185
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)<td>True</table>
|
|
181
|
-
<h3 class="anchor
|
|
186
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reduced_hour_log_retain_time>REDUCED_HOUR_LOG_RETAIN_TIME<a href=#reduced_hour_log_retain_time class=hash-link aria-label="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME" title="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
182
187
|
<p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
|
|
183
188
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)<td>True</table>
|
|
184
|
-
<h3 class="anchor
|
|
189
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reduced_day_log_retain_time>REDUCED_DAY_LOG_RETAIN_TIME<a href=#reduced_day_log_retain_time class=hash-link aria-label="Direct link to REDUCED_DAY_LOG_RETAIN_TIME" title="Direct link to REDUCED_DAY_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
185
190
|
<p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
|
|
186
191
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced day telemetry logs (default = nil = Forever)<td>True</table>
|
|
187
|
-
<h3 class="anchor
|
|
192
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=log_retain_time>LOG_RETAIN_TIME<a href=#log_retain_time class=hash-link aria-label="Direct link to LOG_RETAIN_TIME" title="Direct link to LOG_RETAIN_TIME" translate=no></a></h3>
|
|
188
193
|
<p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
|
|
189
194
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep all regular telemetry logs (default = nil = Forever)<td>True</table>
|
|
190
|
-
<h3 class="anchor
|
|
195
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reduced_log_retain_time>REDUCED_LOG_RETAIN_TIME<a href=#reduced_log_retain_time class=hash-link aria-label="Direct link to REDUCED_LOG_RETAIN_TIME" title="Direct link to REDUCED_LOG_RETAIN_TIME" translate=no></a></h3>
|
|
191
196
|
<p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
|
|
192
197
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep all reduced telemetry logs (default = nil = Forever)<td>True</table>
|
|
193
|
-
<h3 class="anchor
|
|
198
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cleanup_poll_time>CLEANUP_POLL_TIME<a href=#cleanup_poll_time class=hash-link aria-label="Direct link to CLEANUP_POLL_TIME" title="Direct link to CLEANUP_POLL_TIME" translate=no></a></h3>
|
|
194
199
|
<p><strong>Period at which to run the cleanup process.</strong></p>
|
|
195
200
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds between runs of the cleanup process (default = 600 = 10 minutes)<td>True</table>
|
|
196
|
-
<h3 class="anchor
|
|
201
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reducer_disable>REDUCER_DISABLE<a href=#reducer_disable class=hash-link aria-label="Direct link to REDUCER_DISABLE" title="Direct link to REDUCER_DISABLE" translate=no></a></h3>
|
|
197
202
|
<p><strong>Disables the data reduction microservice for the target</strong></p>
|
|
198
|
-
<h3 class="anchor
|
|
203
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=reducer_max_cpu_utilization>REDUCER_MAX_CPU_UTILIZATION<a href=#reducer_max_cpu_utilization class=hash-link aria-label="Direct link to REDUCER_MAX_CPU_UTILIZATION" title="Direct link to REDUCER_MAX_CPU_UTILIZATION" translate=no></a></h3>
|
|
199
204
|
<p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
|
|
200
205
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Percentage<td>0 to 100 percent (default = 30)<td>True</table>
|
|
201
|
-
<h3 class="anchor
|
|
206
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=target_microservice>TARGET_MICROSERVICE<a href=#target_microservice class=hash-link aria-label="Direct link to TARGET_MICROSERVICE" title="Direct link to TARGET_MICROSERVICE" translate=no></a></h3>
|
|
202
207
|
<p><div class=right>(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
|
|
203
208
|
<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>
|
|
204
209
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP<td>True</table>
|
|
205
|
-
<h3 class="anchor
|
|
210
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=packet>PACKET<a href=#packet class=hash-link aria-label="Direct link to PACKET" title="Direct link to PACKET" translate=no></a></h3>
|
|
206
211
|
<p><div class=right>(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
|
|
207
212
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Packet Name<td>The packet name. Does not apply to REDUCER or CLEANUP target microservice types.<td>True</table>
|
|
208
|
-
<h3 class="anchor
|
|
213
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=disable_erb>DISABLE_ERB<a href=#disable_erb class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB" translate=no></a></h3>
|
|
209
214
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
210
215
|
<p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
|
|
211
216
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
|
|
212
|
-
<h3 class="anchor
|
|
217
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=shard-1>SHARD<a href=#shard-1 class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD" translate=no></a></h3>
|
|
213
218
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
214
219
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
215
220
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
216
221
|
<p>Example Usage:</p>
|
|
217
|
-
<div class="language-ruby
|
|
218
|
-
<h2 class="anchor
|
|
222
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><br/></span></code></pre></div></div>
|
|
223
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=microservice-1>MICROSERVICE<a href=#microservice-1 class=hash-link aria-label="Direct link to MICROSERVICE" title="Direct link to MICROSERVICE" translate=no></a></h2>
|
|
219
224
|
<p><strong>Defines a new microservice</strong></p>
|
|
220
225
|
<p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
|
|
221
226
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Microservice Folder Name<td>The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName<td>True<tr><td>Microservice Name<td>The specific name of this instance of the microservice in the OpenC3 system<td>True</table>
|
|
222
227
|
<p>Example Usage:</p>
|
|
223
|
-
<div class="language-ruby
|
|
224
|
-
<h2 class="anchor
|
|
228
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span></code></pre></div></div>
|
|
229
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=microservice-modifiers>MICROSERVICE Modifiers<a href=#microservice-modifiers class=hash-link aria-label="Direct link to MICROSERVICE Modifiers" title="Direct link to MICROSERVICE Modifiers" translate=no></a></h2>
|
|
225
230
|
<p>The following keywords must follow a MICROSERVICE keyword.</p>
|
|
226
|
-
<h3 class="anchor
|
|
231
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=env-1>ENV<a href=#env-1 class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV" translate=no></a></h3>
|
|
227
232
|
<p><strong>Sets an environment variable in the microservice.</strong></p>
|
|
228
233
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>Environment variable name<td>True<tr><td>Value<td>Environment variable value<td>True</table>
|
|
229
234
|
<p>Example Usage:</p>
|
|
230
|
-
<div class="language-ruby
|
|
231
|
-
<h3 class="anchor
|
|
235
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</span><br/></span></code></pre></div></div>
|
|
236
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=work_dir-1>WORK_DIR<a href=#work_dir-1 class=hash-link aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR" translate=no></a></h3>
|
|
232
237
|
<p><strong>Set the working directory</strong></p>
|
|
233
238
|
<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
239
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Directory<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>True</table>
|
|
235
240
|
<p>Example Usage:</p>
|
|
236
|
-
<div class="language-ruby
|
|
237
|
-
<h3 class="anchor
|
|
241
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WORK_DIR</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><br/></span></code></pre></div></div>
|
|
242
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=port-1>PORT<a href=#port-1 class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT" translate=no></a></h3>
|
|
238
243
|
<p><div class=right>(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
|
|
239
244
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
240
245
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Number<td>Port number<td>True<tr><td>Protocol<td>Port protocol. Default is TCP.<td>False</table>
|
|
241
246
|
<p>Example Usage:</p>
|
|
242
|
-
<div class="language-ruby
|
|
243
|
-
<h3 class="anchor
|
|
247
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</span><br/></span></code></pre></div></div>
|
|
248
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=topic>TOPIC<a href=#topic class=hash-link aria-label="Direct link to TOPIC" title="Direct link to TOPIC" translate=no></a></h3>
|
|
244
249
|
<p><strong>Associate a Redis topic</strong></p>
|
|
245
250
|
<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
251
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Topic Name<td>Redis Topic to associate with the microservice<td>True</table>
|
|
247
252
|
<p>Example Usage:</p>
|
|
248
|
-
<div class="language-ruby
|
|
249
|
-
<h3 class="anchor
|
|
253
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Manually assigning topics is an advanced topic and requires</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># intimate knowledge of the internal COSMOS data structures.</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TOPIC</span><span class="token plain"> DEFAULT__openc3_log_messages</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TOPIC</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT__TELEMETRY__EXAMPLE__STATUS</span><br/></span></code></pre></div></div>
|
|
254
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=target_name>TARGET_NAME<a href=#target_name class=hash-link aria-label="Direct link to TARGET_NAME" title="Direct link to TARGET_NAME" translate=no></a></h3>
|
|
250
255
|
<p><strong>Associate a OpenC3 target</strong></p>
|
|
251
256
|
<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
257
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>OpenC3 target to associate with the microservice<td>True</table>
|
|
253
258
|
<p>Example Usage:</p>
|
|
254
|
-
<div class="language-ruby
|
|
255
|
-
<h3 class="anchor
|
|
259
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET_NAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><br/></span></code></pre></div></div>
|
|
260
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=cmd-1>CMD<a href=#cmd-1 class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD" translate=no></a></h3>
|
|
256
261
|
<p><strong>Command line to execute to run the microservice.</strong></p>
|
|
257
262
|
<p>Command line to execute to run the microservice.</p>
|
|
258
263
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>One or more arguments to exec to run the microservice.<td>True</table>
|
|
259
|
-
<div class="theme-tabs-container tabs-container
|
|
260
|
-
<h3 class="anchor
|
|
264
|
+
<div class="theme-tabs-container tabs-container tabList_uzd6"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_cfk4 tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_cfk4">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Gr6z><div class="language-python codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-python codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token plain">MICROSERVICE EXAMPLE openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> CMD python example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Gr6z hidden><div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CMD</span><span class="token plain"> ruby example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br/></span></code></pre></div></div></div></div></div>
|
|
265
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=option-1>OPTION<a href=#option-1 class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION" translate=no></a></h3>
|
|
261
266
|
<p><strong>Pass an option to the microservice</strong></p>
|
|
262
267
|
<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>
|
|
263
268
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Option Name<td>Name of the option<td>True<tr><td>Option Value(s)<td>One or more values to associate with the option<td>True</table>
|
|
264
|
-
<h3 class="anchor
|
|
269
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=container-1>CONTAINER<a href=#container-1 class=hash-link aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER" translate=no></a></h3>
|
|
265
270
|
<p><strong>Docker Container</strong></p>
|
|
266
271
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise.</p>
|
|
267
272
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>Name of the container<td>False</table>
|
|
268
|
-
<h3 class="anchor
|
|
273
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=secret-1>SECRET<a href=#secret-1 class=hash-link aria-label="Direct link to SECRET" title="Direct link to SECRET" translate=no></a></h3>
|
|
269
274
|
<p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
|
|
270
275
|
<p>Defines a secret for this microservice. For more information see <a class="" href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
|
|
271
276
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.<td>True<tr><td>Secret Name<td>The name of the secret to retrieve from the Admin / Secrets tab. For more information see <a class="" href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.<td>True<tr><td>Environment Variable or File Path<td>Environment variable name or file path to store secret<td>True<tr><td>Secret Store Name<td>Name of the secret store for stores with multipart keys<td>False</table>
|
|
272
277
|
<p>Example Usage:</p>
|
|
273
|
-
<div class="language-ruby
|
|
274
|
-
<h3 class="anchor
|
|
278
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"/tmp/DATA/cert"</span><br/></span></code></pre></div></div>
|
|
279
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=route_prefix-1>ROUTE_PREFIX<a href=#route_prefix-1 class=hash-link aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX" translate=no></a></h3>
|
|
275
280
|
<p><div class=right>(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
|
|
276
281
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
277
282
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Route Prefix<td>Route prefix. Must be unique across all scopes. Something like /myprefix<td>True</table>
|
|
278
283
|
<p>Example Usage:</p>
|
|
279
|
-
<div class="language-ruby
|
|
280
|
-
<h3 class="anchor
|
|
284
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">cfdp</span><br/></span></code></pre></div></div>
|
|
285
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=disable_erb-1>DISABLE_ERB<a href=#disable_erb-1 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB" translate=no></a></h3>
|
|
281
286
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
282
287
|
<p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
|
|
283
288
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
|
|
284
|
-
<h3 class="anchor
|
|
289
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=shard-2>SHARD<a href=#shard-2 class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD" translate=no></a></h3>
|
|
285
290
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
286
291
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
287
292
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
288
293
|
<p>Example Usage:</p>
|
|
289
|
-
<div class="language-ruby
|
|
290
|
-
<h3 class="anchor
|
|
294
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><br/></span></code></pre></div></div>
|
|
295
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=stopped>STOPPED<a href=#stopped class=hash-link aria-label="Direct link to STOPPED" title="Direct link to STOPPED" translate=no></a></h3>
|
|
291
296
|
<p><div class=right>(Since 6.2.0)</div><strong>Initially creates the microservice in a stopped state (not enabled)</strong><p></p>
|
|
292
297
|
<p>Example Usage:</p>
|
|
293
|
-
<div class="language-ruby
|
|
294
|
-
<h2 class="anchor
|
|
298
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">STOPPED</span><br/></span></code></pre></div></div>
|
|
299
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=tool-1>TOOL<a href=#tool-1 class=hash-link aria-label="Direct link to TOOL" title="Direct link to TOOL" translate=no></a></h2>
|
|
295
300
|
<p><strong>Define a tool</strong></p>
|
|
296
301
|
<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>
|
|
297
302
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Tool Folder Name<td>The exact name of the tool folder in the plugin. ie. tools/ToolFolderName<td>True<tr><td>Tool Name<td>Name of the tool that is displayed in the OpenC3 Navigation menu<td>True</table>
|
|
298
303
|
<p>Example Usage:</p>
|
|
299
|
-
<div class="language-ruby
|
|
300
|
-
<h2 class="anchor
|
|
304
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TOOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEMO</span><span class="token plain"> Demo</span><br/></span></code></pre></div></div>
|
|
305
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=tool-modifiers>TOOL Modifiers<a href=#tool-modifiers class=hash-link aria-label="Direct link to TOOL Modifiers" title="Direct link to TOOL Modifiers" translate=no></a></h2>
|
|
301
306
|
<p>The following keywords must follow a TOOL keyword.</p>
|
|
302
|
-
<h3 class="anchor
|
|
307
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=url>URL<a href=#url class=hash-link aria-label="Direct link to URL" title="Direct link to URL" translate=no></a></h3>
|
|
303
308
|
<p><strong>Url used to access the tool</strong></p>
|
|
304
309
|
<p>The relative url used to access the tool. Defaults to "/tools/ToolFolderName".</p>
|
|
305
310
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Url<td>The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.<td>True</table>
|
|
306
|
-
<h3 class="anchor
|
|
311
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=inline_url>INLINE_URL<a href=#inline_url class=hash-link aria-label="Direct link to INLINE_URL" title="Direct link to INLINE_URL" translate=no></a></h3>
|
|
307
312
|
<p><strong>Internal url to load a tool</strong></p>
|
|
308
313
|
<p>The url of the javascript file used to load the tool into single-SPA. Defaults to "main.js".</p>
|
|
309
314
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Url<td>The inline url. If not given defaults to main.js. Generally should not be given unless using a non-standard filename.<td>True</table>
|
|
310
|
-
<h3 class="anchor
|
|
315
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=window>WINDOW<a href=#window class=hash-link aria-label="Direct link to WINDOW" title="Direct link to WINDOW" translate=no></a></h3>
|
|
311
316
|
<p><strong>How to display the tool when navigated to</strong></p>
|
|
312
317
|
<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>
|
|
313
318
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Window Mode<td>Tool display mode<br/><br/>Valid Values: <span class=values>INLINE, IFRAME, NEW</span><td>True</table>
|
|
314
|
-
<h3 class="anchor
|
|
319
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=icon>ICON<a href=#icon class=hash-link aria-label="Direct link to ICON" title="Direct link to ICON" translate=no></a></h3>
|
|
315
320
|
<p><strong>Set tool icon</strong></p>
|
|
316
321
|
<p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
|
|
317
322
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Icon Name<td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href=https://materialdesignicons.com/ target=_blank rel="noopener noreferrer" class="">https://materialdesignicons.com/</a>), and Astro.<td>True</table>
|
|
318
|
-
<h3 class="anchor
|
|
323
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=category>CATEGORY<a href=#category class=hash-link aria-label="Direct link to CATEGORY" title="Direct link to CATEGORY" translate=no></a></h3>
|
|
319
324
|
<p><strong>Category for the tool</strong></p>
|
|
320
325
|
<p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
|
|
321
326
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Category Name<td>Category to associate the tool with<td>True</table>
|
|
322
|
-
<h3 class="anchor
|
|
327
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=shown>SHOWN<a href=#shown class=hash-link aria-label="Direct link to SHOWN" title="Direct link to SHOWN" translate=no></a></h3>
|
|
323
328
|
<p><strong>Show the tool or not</strong></p>
|
|
324
329
|
<p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
|
|
325
330
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shown<td>Whether or not the tool is shown. TRUE or FALSE<br/><br/>Valid Values: <span class=values>true, false</span><td>True</table>
|
|
326
|
-
<h3 class="anchor
|
|
331
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=position>POSITION<a href=#position class=hash-link aria-label="Direct link to POSITION" title="Direct link to POSITION" translate=no></a></h3>
|
|
327
332
|
<p><div class=right>(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
|
|
328
333
|
<p>Position of the tool starting at 2 (1 is reserved for Admin Console). Tools without a position are appended to the end as they are installed. All COSMOS Core tools have consecutive integer values for position.</p>
|
|
329
334
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Position<td>Numerical position<td>True</table>
|
|
330
|
-
<h3 class="anchor
|
|
335
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=disable_erb-2>DISABLE_ERB<a href=#disable_erb-2 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB" translate=no></a></h3>
|
|
331
336
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
332
337
|
<p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
|
|
333
338
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
|
|
334
|
-
<h3 class="anchor
|
|
339
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=import_map_item>IMPORT_MAP_ITEM<a href=#import_map_item class=hash-link aria-label="Direct link to IMPORT_MAP_ITEM" title="Direct link to IMPORT_MAP_ITEM" translate=no></a></h3>
|
|
335
340
|
<p><div class=right>(Since 6.0.0)</div><strong>Add an item to the import map</strong><p></p>
|
|
336
341
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>key<td>Import Map Key<td>True<tr><td>value<td>Import Map Value<td>True</table>
|
|
337
|
-
<h2 class="anchor
|
|
342
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=widget>WIDGET<a href=#widget class=hash-link aria-label="Direct link to WIDGET" title="Direct link to WIDGET" translate=no></a></h2>
|
|
338
343
|
<p><strong>Define a custom widget</strong></p>
|
|
339
344
|
<p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
|
|
340
345
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Widget Name<td>The name of the widget will 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 class="" href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a> guide for more details.<td>True<tr><td>Label<td>The label for the widget that will appear in the Data Viewer component drop down<td>False</table>
|
|
341
346
|
<p>Example Usage:</p>
|
|
342
|
-
<div class="language-ruby
|
|
343
|
-
<h2 class="anchor
|
|
347
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HELLOWORLD</span><br/></span></code></pre></div></div>
|
|
348
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=widget-modifiers>WIDGET Modifiers<a href=#widget-modifiers class=hash-link aria-label="Direct link to WIDGET Modifiers" title="Direct link to WIDGET Modifiers" translate=no></a></h2>
|
|
344
349
|
<p>The following keywords must follow a WIDGET keyword.</p>
|
|
345
|
-
<h3 class="anchor
|
|
350
|
+
<h3 class="anchor anchorTargetStickyNavbar_Bk1k" id=disable_erb-3>DISABLE_ERB<a href=#disable_erb-3 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB" translate=no></a></h3>
|
|
346
351
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
347
352
|
<p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
|
|
348
353
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
|
|
349
|
-
<h2 class="anchor
|
|
350
|
-
<p><strong>Define a script engine to add language support to Script Runner</strong></p>
|
|
351
|
-
<p>Defines a script engine to add language support to Script Runner</p>
|
|
354
|
+
<h2 class="anchor anchorTargetStickyNavbar_Bk1k" id=script_engine>SCRIPT_ENGINE<a href=#script_engine class=hash-link aria-label="Direct link to SCRIPT_ENGINE" title="Direct link to SCRIPT_ENGINE" translate=no></a></h2>
|
|
355
|
+
<p><div class=right>(Since 6.5.0)</div><strong>Define a script engine to add language support to Script Runner</strong><p></p>
|
|
356
|
+
<p>Defines a script engine to add language support to Script Runner. For a realistic example, see our <a href=https://github.com/OpenC3/openc3-cosmos-script-engine-cstol target=_blank rel="noopener noreferrer" class="">CSTOL</a> plugin.</p>
|
|
352
357
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Extension<td>Extension that will use this script engine<td>True<tr><td>Script Engine Filename<td>Filename that implements the script engine. Should be in top level lib folder in plugin.<td>True</table>
|
|
353
358
|
<p>Example Usage:</p>
|
|
354
|
-
<div class="language-ruby codeBlockContainer_Sxhe theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_Jhdg><pre tabindex=0 class="prism-code language-ruby codeBlock_cMOg thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_tu4E><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SCRIPT_ENGINE</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">print print_script_engine</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br/></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_Tv9o"><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_jEMW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_sfFo"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" 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_Cvk4 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><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><a href=#interface class="table-of-contents__link toc-highlight">Interface</a><li><a href=#router class="table-of-contents__link toc-highlight">Router</a><li><a href=#tool class="table-of-contents__link toc-highlight">Tool</a><li><a href=#microservice class="table-of-contents__link toc-highlight">Microservice</a></ul><li><a href=#plugin-directory-structure class="table-of-contents__link toc-highlight">Plugin Directory Structure</a><li><a href=#plugintxt-configuration-file class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a><li><a href=#variable class="table-of-contents__link toc-highlight">VARIABLE</a><li><a href=#needs_dependencies class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a><li><a href=#interface-1 class="table-of-contents__link toc-highlight">INTERFACE</a><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><a href=#map_cmd_target class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a><li><a href=#map_tlm_target class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a><li><a href=#dont_connect class="table-of-contents__link toc-highlight">DONT_CONNECT</a><li><a href=#dont_reconnect class="table-of-contents__link toc-highlight">DONT_RECONNECT</a><li><a href=#reconnect_delay class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a><li><a href=#disable_disconnect class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a><li><a href=#log_raw class="table-of-contents__link toc-highlight">LOG_RAW</a><li><a href=#log_stream class="table-of-contents__link toc-highlight">LOG_STREAM</a><li><a href=#protocol class="table-of-contents__link toc-highlight">PROTOCOL</a><li><a href=#option class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#secret class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#env class="table-of-contents__link toc-highlight">ENV</a><li><a href=#work_dir class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port class="table-of-contents__link toc-highlight">PORT</a><li><a href=#cmd class="table-of-contents__link toc-highlight">CMD</a><li><a href=#container class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#route_prefix class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#shard class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#router-1 class="table-of-contents__link toc-highlight">ROUTER</a><li><a href=#target-1 class="table-of-contents__link toc-highlight">TARGET</a><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><a href=#cmd_log_cycle_time class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a><li><a href=#cmd_log_cycle_size class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a><li><a href=#cmd_log_retain_time class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a><li><a href=#cmd_decom_log_cycle_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a><li><a href=#cmd_decom_log_cycle_size class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a><li><a href=#cmd_decom_log_retain_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a><li><a href=#tlm_buffer_depth class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a><li><a href=#tlm_log_cycle_time class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a><li><a href=#tlm_log_cycle_size class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a><li><a href=#tlm_log_retain_time class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a><li><a href=#tlm_decom_log_cycle_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a><li><a href=#tlm_decom_log_cycle_size class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a><li><a href=#tlm_decom_log_retain_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a><li><a href=#reduced_minute_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a><li><a href=#reduced_hour_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a><li><a href=#reduced_day_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a><li><a href=#log_retain_time class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a><li><a href=#reduced_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a><li><a href=#cleanup_poll_time class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a><li><a href=#reducer_disable class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a><li><a href=#reducer_max_cpu_utilization class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a><li><a href=#target_microservice class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a><li><a href=#packet class="table-of-contents__link toc-highlight">PACKET</a><li><a href=#disable_erb class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-1 class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#microservice-1 class="table-of-contents__link toc-highlight">MICROSERVICE</a><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><a href=#work_dir-1 class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port-1 class="table-of-contents__link toc-highlight">PORT</a><li><a href=#topic class="table-of-contents__link toc-highlight">TOPIC</a><li><a href=#target_name class="table-of-contents__link toc-highlight">TARGET_NAME</a><li><a href=#cmd-1 class="table-of-contents__link toc-highlight">CMD</a><li><a href=#option-1 class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#container-1 class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#secret-1 class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#route_prefix-1 class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#disable_erb-1 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-2 class="table-of-contents__link toc-highlight">SHARD</a><li><a href=#stopped class="table-of-contents__link toc-highlight">STOPPED</a></ul><li><a href=#tool-1 class="table-of-contents__link toc-highlight">TOOL</a><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><a href=#inline_url class="table-of-contents__link toc-highlight">INLINE_URL</a><li><a href=#window class="table-of-contents__link toc-highlight">WINDOW</a><li><a href=#icon class="table-of-contents__link toc-highlight">ICON</a><li><a href=#category class="table-of-contents__link toc-highlight">CATEGORY</a><li><a href=#shown class="table-of-contents__link toc-highlight">SHOWN</a><li><a href=#position class="table-of-contents__link toc-highlight">POSITION</a><li><a href=#disable_erb-2 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#import_map_item class="table-of-contents__link toc-highlight">IMPORT_MAP_ITEM</a></ul><li><a href=#widget class="table-of-contents__link toc-highlight">WIDGET</a><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></ul><li><a href=#script_engine class="table-of-contents__link toc-highlight">SCRIPT_ENGINE</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column 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-label="(opens in new tab)" class=iconExternalLink_RxcI><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column 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-label="(opens in new tab)" class=iconExternalLink_RxcI><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|
|
359
|
+
<div class="language-ruby codeBlockContainer_wEXy theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mUF7><pre tabindex=0 class="prism-code language-ruby codeBlock_myoZ thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_mAVG><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SCRIPT_ENGINE</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">print print_script_engine</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br/></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_lXWe"><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_tla4 aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_bvLG"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" 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_M2AT 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><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><a href=#interface class="table-of-contents__link toc-highlight">Interface</a><li><a href=#router class="table-of-contents__link toc-highlight">Router</a><li><a href=#widgets class="table-of-contents__link toc-highlight">Widgets</a><li><a href=#tool class="table-of-contents__link toc-highlight">Tool</a><li><a href=#microservice class="table-of-contents__link toc-highlight">Microservice</a><li><a href=#script-engines class="table-of-contents__link toc-highlight">Script Engines</a></ul><li><a href=#plugin-directory-structure class="table-of-contents__link toc-highlight">Plugin Directory Structure</a><li><a href=#plugintxt-configuration-file class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a><li><a href=#variable class="table-of-contents__link toc-highlight">VARIABLE</a><li><a href=#needs_dependencies class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a><li><a href=#interface-1 class="table-of-contents__link toc-highlight">INTERFACE</a><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><a href=#map_cmd_target class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a><li><a href=#map_tlm_target class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a><li><a href=#dont_connect class="table-of-contents__link toc-highlight">DONT_CONNECT</a><li><a href=#dont_reconnect class="table-of-contents__link toc-highlight">DONT_RECONNECT</a><li><a href=#reconnect_delay class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a><li><a href=#disable_disconnect class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a><li><a href=#log_raw class="table-of-contents__link toc-highlight">LOG_RAW</a><li><a href=#log_stream class="table-of-contents__link toc-highlight">LOG_STREAM</a><li><a href=#protocol class="table-of-contents__link toc-highlight">PROTOCOL</a><li><a href=#option class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#secret class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#env class="table-of-contents__link toc-highlight">ENV</a><li><a href=#work_dir class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port class="table-of-contents__link toc-highlight">PORT</a><li><a href=#cmd class="table-of-contents__link toc-highlight">CMD</a><li><a href=#container class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#route_prefix class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#shard class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#router-1 class="table-of-contents__link toc-highlight">ROUTER</a><li><a href=#target-1 class="table-of-contents__link toc-highlight">TARGET</a><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><a href=#cmd_log_cycle_time class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a><li><a href=#cmd_log_cycle_size class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a><li><a href=#cmd_log_retain_time class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a><li><a href=#cmd_decom_log_cycle_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a><li><a href=#cmd_decom_log_cycle_size class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a><li><a href=#cmd_decom_log_retain_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a><li><a href=#tlm_buffer_depth class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a><li><a href=#tlm_log_cycle_time class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a><li><a href=#tlm_log_cycle_size class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a><li><a href=#tlm_log_retain_time class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a><li><a href=#tlm_decom_log_cycle_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a><li><a href=#tlm_decom_log_cycle_size class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a><li><a href=#tlm_decom_log_retain_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a><li><a href=#reduced_minute_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a><li><a href=#reduced_hour_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a><li><a href=#reduced_day_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a><li><a href=#log_retain_time class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a><li><a href=#reduced_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a><li><a href=#cleanup_poll_time class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a><li><a href=#reducer_disable class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a><li><a href=#reducer_max_cpu_utilization class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a><li><a href=#target_microservice class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a><li><a href=#packet class="table-of-contents__link toc-highlight">PACKET</a><li><a href=#disable_erb class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-1 class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#microservice-1 class="table-of-contents__link toc-highlight">MICROSERVICE</a><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><a href=#work_dir-1 class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port-1 class="table-of-contents__link toc-highlight">PORT</a><li><a href=#topic class="table-of-contents__link toc-highlight">TOPIC</a><li><a href=#target_name class="table-of-contents__link toc-highlight">TARGET_NAME</a><li><a href=#cmd-1 class="table-of-contents__link toc-highlight">CMD</a><li><a href=#option-1 class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#container-1 class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#secret-1 class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#route_prefix-1 class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#disable_erb-1 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-2 class="table-of-contents__link toc-highlight">SHARD</a><li><a href=#stopped class="table-of-contents__link toc-highlight">STOPPED</a></ul><li><a href=#tool-1 class="table-of-contents__link toc-highlight">TOOL</a><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><a href=#inline_url class="table-of-contents__link toc-highlight">INLINE_URL</a><li><a href=#window class="table-of-contents__link toc-highlight">WINDOW</a><li><a href=#icon class="table-of-contents__link toc-highlight">ICON</a><li><a href=#category class="table-of-contents__link toc-highlight">CATEGORY</a><li><a href=#shown class="table-of-contents__link toc-highlight">SHOWN</a><li><a href=#position class="table-of-contents__link toc-highlight">POSITION</a><li><a href=#disable_erb-2 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#import_map_item class="table-of-contents__link toc-highlight">IMPORT_MAP_ITEM</a></ul><li><a href=#widget class="table-of-contents__link toc-highlight">WIDGET</a><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></ul><li><a href=#script_engine class="table-of-contents__link toc-highlight">SCRIPT_ENGINE</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column 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-label="(opens in new tab)" class=iconExternalLink_TntV><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column 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-label="(opens in new tab)" class=iconExternalLink_TntV><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|