openc3-cosmos-tool-docs 6.8.1 → 6.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/Rakefile +1 -1
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/css/styles.946be27d.css +1 -0
- data/tools/staticdocs/assets/js/019369f3.64763f3d.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.3d58085e.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +1 -0
- data/tools/staticdocs/assets/js/{0f5d161c.0727eb1b.js → 0f5d161c.978b9fee.js} +1 -1
- data/tools/staticdocs/assets/js/0ff569c9.27128023.js +1 -0
- data/tools/staticdocs/assets/js/10209fc9.669ef887.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.1a538098.js +1 -0
- data/tools/staticdocs/assets/js/{13196248.9e1ebaa5.js → 13196248.f932d5bd.js} +1 -1
- data/tools/staticdocs/assets/js/{13c1b4e4.6446ccbc.js → 13c1b4e4.9735bb59.js} +1 -1
- data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +1 -0
- data/tools/staticdocs/assets/js/{1e02e6a3.a89f2446.js → 1e02e6a3.da7b7250.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.0955283c.js → 2047b354.c86efa5f.js} +1 -1
- data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.858cb22d.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +1 -0
- data/tools/staticdocs/assets/js/3326.2db66e1b.js +4 -0
- data/tools/staticdocs/assets/js/3402.80344ef5.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +1 -0
- data/tools/staticdocs/assets/js/{3dd7ef3b.f43cd057.js → 3dd7ef3b.ceb26a04.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.f6769d57.js +1 -0
- data/tools/staticdocs/assets/js/4071.821f3b2b.js +1 -0
- data/tools/staticdocs/assets/js/{411898ad.28293824.js → 411898ad.8ed3452c.js} +1 -1
- data/tools/staticdocs/assets/js/42170351.7ff72adc.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +1 -0
- data/tools/staticdocs/assets/js/5072.9a0a2752.js +1 -0
- data/tools/staticdocs/assets/js/{53ca7c5b.9468b8ed.js → 53ca7c5b.3ae5bb0f.js} +1 -1
- data/tools/staticdocs/assets/js/54d0d530.2f7aa091.js +1 -0
- data/tools/staticdocs/assets/js/5525.dd1645b0.js +101 -0
- data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.821e5ed4.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +1 -0
- data/tools/staticdocs/assets/js/6246.60dfff30.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.dc5bae56.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.d197d085.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d400f853.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.7e6fb4fd.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.338d2338.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +1 -0
- data/tools/staticdocs/assets/js/{8434.a3e5442b.js → 9623.44668503.js} +1 -1
- data/tools/staticdocs/assets/js/{964eb012.4253acd5.js → 964eb012.c7f626c5.js} +1 -1
- data/tools/staticdocs/assets/js/97535711.a6342866.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +1 -0
- data/tools/staticdocs/assets/js/{9d6e81d0.b9f15524.js → 9d6e81d0.879c9e9e.js} +1 -1
- data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.758701f0.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.6bcbf484.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.9e7f0be7.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +1 -0
- data/tools/staticdocs/assets/js/{b9f60ba6.2c4823f0.js → b9f60ba6.63638354.js} +1 -1
- data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +1 -0
- data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +1 -0
- data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.6b4ab31e.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.4e811739.js +1 -0
- data/tools/staticdocs/assets/js/{dc5f7beb.15b70d4b.js → dc5f7beb.c703e464.js} +1 -1
- data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.8591b830.js +1 -0
- data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +1 -0
- data/tools/staticdocs/assets/js/{fd886806.f7bfd80c.js → fd886806.fb8a587e.js} +1 -1
- data/tools/staticdocs/assets/js/main.331b7e10.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.53a0c91e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +46 -46
- data/tools/staticdocs/docs/configuration/command.html +97 -97
- data/tools/staticdocs/docs/configuration/conversions.html +53 -53
- data/tools/staticdocs/docs/configuration/format.html +22 -22
- 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 +127 -127
- data/tools/staticdocs/docs/configuration/processors.html +17 -17
- 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 +53 -53
- data/tools/staticdocs/docs/configuration/target.html +21 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +289 -289
- data/tools/staticdocs/docs/configuration/telemetry.html +86 -86
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +14 -14
- data/tools/staticdocs/docs/development/developing.html +27 -27
- data/tools/staticdocs/docs/development/json-api.html +15 -15
- data/tools/staticdocs/docs/development/log-structure.html +13 -13
- 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 +20 -20
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/cli.html +39 -39
- data/tools/staticdocs/docs/getting-started/generators.html +25 -25
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
- data/tools/staticdocs/docs/getting-started/installation.html +23 -21
- 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 +47 -47
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +19 -12
- data/tools/staticdocs/docs/guides/cfs.html +32 -32
- data/tools/staticdocs/docs/guides/custom-widgets.html +36 -36
- data/tools/staticdocs/docs/guides/dynamic-packets.html +8 -8
- 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/script-writing.html +80 -80
- data/tools/staticdocs/docs/guides/scripting-api.html +707 -635
- data/tools/staticdocs/docs/guides/troubleshooting.html +8 -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/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 +24 -24
- data/tools/staticdocs/docs/tools/autonomic.html +19 -19
- data/tools/staticdocs/docs/tools/bucket-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/calendar.html +18 -18
- data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +20 -20
- 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 +25 -25
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +16 -16
- data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/packet-viewer.html +12 -12
- data/tools/staticdocs/docs/tools/script-runner.html +43 -43
- data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
- data/tools/staticdocs/docs/tools/table-manager.html +11 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -22
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- 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-1759527994448.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1759527994448.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +92 -92
- data/tools/staticdocs/assets/css/styles.0edf3032.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.5366d64b.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.eb311155.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.974abc47.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +0 -1
- data/tools/staticdocs/assets/js/10209fc9.ae369363.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.32c30401.js +0 -1
- data/tools/staticdocs/assets/js/1085.d1eba438.js +0 -1
- data/tools/staticdocs/assets/js/1319.d9ec0592.js +0 -101
- data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.81906212.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.db29df30.js +0 -1
- data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.35825078.js +0 -1
- data/tools/staticdocs/assets/js/5074.653f3924.js +0 -1
- data/tools/staticdocs/assets/js/5410.60ab1dba.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +0 -1
- data/tools/staticdocs/assets/js/59ed27a4.8eb3444b.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +0 -1
- data/tools/staticdocs/assets/js/6242.bdac32c1.js +0 -4
- data/tools/staticdocs/assets/js/6831b732.7cf97282.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.b96d263c.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +0 -1
- data/tools/staticdocs/assets/js/8851.4837d29a.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +0 -1
- data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +0 -1
- data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.791cdc39.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.2695e35a.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.71b17b00.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.c8eb51b6.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.e240f32e.js +0 -1
- data/tools/staticdocs/assets/js/b38a6d74.7363be85.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.2a473696.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.482b8f7b.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +0 -1
- data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +0 -1
- data/tools/staticdocs/assets/js/f75a5f33.4d2501bc.js +0 -1
- data/tools/staticdocs/assets/js/main.994f9f74.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.44311138.js +0 -1
- data/tools/staticdocs/lunr-index-1757781681330.json +0 -1
- data/tools/staticdocs/search-doc-1757781681330.json +0 -1
|
@@ -1,354 +1,354 @@
|
|
|
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><meta charset=UTF-8><meta name=generator content="Docusaurus v3.
|
|
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.1"><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.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.53a0c91e.js defer></script><script src=/tools/staticdocs/assets/js/main.331b7e10.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="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="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_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</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>File Format</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>Plugins</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>Targets</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>Commands</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>Telemetry</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>Interfaces</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>Protocols</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>Accessors</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>Conversions</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>Processors</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>Limits Response</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>Tables</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>Screens</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>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li 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_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=introduction>Introduction<a href=#introduction class=hash-link aria-label="Direct link to Introduction" title="Direct link to Introduction"></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_TKVD 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_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></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_YWZZ><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_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><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_THKR>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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>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_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_THKR>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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>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_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" 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_u_XA><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_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 class="anchor anchorWithStickyNavbar_TUrh" 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
6
|
<p>Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality.</p>
|
|
7
7
|
<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
|
|
8
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=concepts>Concepts<a href=#concepts class=hash-link aria-label="Direct link to Concepts" title="Direct link to Concepts" translate=no></a></h2>
|
|
9
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
10
|
<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
|
|
11
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
12
|
<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
|
|
13
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
14
|
<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
|
|
15
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
16
|
<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
|
|
17
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
18
|
<p>Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks.</p>
|
|
19
|
-
<h2 class="anchor
|
|
19
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
20
|
<p>COSMOS plugins have a well-defined directory structure described in detail in the <a href=/tools/staticdocs/docs/getting-started/generators>Code Generator</a> documentation.</p>
|
|
21
|
-
<h2 class="anchor
|
|
21
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
22
|
<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
23
|
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
|
|
24
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
25
|
<p><strong>Define a configurable variable for the plugin</strong></p>
|
|
26
26
|
<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
27
|
<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
|
|
28
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
29
|
<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
30
|
<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
|
|
31
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
32
|
<p><strong>Defines a connection to a physical target</strong></p>
|
|
33
33
|
<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
|
-
<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
|
|
34
|
+
<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
35
|
<p>Additional parameters are required. Please see the <a href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
|
|
36
|
-
<h2 class="anchor
|
|
36
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
37
|
<p>The following keywords must follow a INTERFACE keyword.</p>
|
|
38
|
-
<h3 class="anchor
|
|
38
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
39
|
<p><strong>Maps a target name to an interface</strong></p>
|
|
40
40
|
<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="tabs-container
|
|
42
|
-
<h3 class="anchor
|
|
41
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
42
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
43
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
|
|
44
44
|
<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="tabs-container
|
|
46
|
-
<h3 class="anchor
|
|
45
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
46
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
47
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
|
|
48
48
|
<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="tabs-container
|
|
50
|
-
<h3 class="anchor
|
|
49
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
50
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
51
|
<p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
|
|
52
|
-
<h3 class="anchor
|
|
52
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
53
|
<p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
|
|
54
|
-
<h3 class="anchor
|
|
54
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
55
|
<p><strong>Reconnect delay in seconds</strong></p>
|
|
56
56
|
<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
57
|
<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
|
|
58
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
59
|
<p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
|
|
60
60
|
<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
|
|
61
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
62
|
<p><strong>Deprecated, use LOG_STREAM</strong></p>
|
|
63
|
-
<h3 class="anchor
|
|
63
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
64
|
<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
65
|
<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
66
|
<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
67
|
<p>Example Usage:</p>
|
|
68
|
-
<div class="language-ruby
|
|
69
|
-
<h3 class="anchor
|
|
68
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
69
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
70
|
<p><div class=right>(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
|
|
71
|
-
<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
|
|
72
|
-
<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
|
|
73
|
-
<div class="tabs-container
|
|
74
|
-
<h3 class="anchor
|
|
71
|
+
<p>Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.<br/><br/> For information on creating your own custom protocol please see <a href=/tools/staticdocs/docs/configuration/protocols>Protocols</a></p>
|
|
72
|
+
<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 tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
74
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
75
|
<p><strong>Set a parameter on an interface</strong></p>
|
|
76
76
|
<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
77
|
<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
78
|
<p>Example Usage:</p>
|
|
79
|
-
<div class="language-ruby
|
|
80
|
-
<h3 class="anchor
|
|
79
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
80
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
81
|
<p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
|
|
82
82
|
<p>Defines a secret for this interface and optionally assigns its value to an option. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
|
|
83
83
|
<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 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
84
|
<p>Example Usage:</p>
|
|
85
|
-
<div class="language-ruby
|
|
86
|
-
<h3 class="anchor
|
|
85
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
86
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
87
|
<p><div class=right>(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
|
|
88
88
|
<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
89
|
<p>Example Usage:</p>
|
|
90
|
-
<div class="language-ruby
|
|
91
|
-
<h3 class="anchor
|
|
90
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
91
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
92
|
<p><div class=right>(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
|
|
93
93
|
<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
94
|
<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
95
|
<p>Example Usage:</p>
|
|
96
|
-
<div class="language-ruby
|
|
97
|
-
<h3 class="anchor
|
|
96
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
97
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
98
|
<p><div class=right>(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
|
|
99
99
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
100
100
|
<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
101
|
<p>Example Usage:</p>
|
|
102
|
-
<div class="language-ruby
|
|
103
|
-
<h3 class="anchor
|
|
102
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
103
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
104
|
<p><div class=right>(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
|
|
105
105
|
<p>Command line to execute to run the microservice.</p>
|
|
106
106
|
<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="tabs-container
|
|
108
|
-
<h3 class="anchor
|
|
107
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
108
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
109
|
<p><div class=right>(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
|
|
110
110
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise.</p>
|
|
111
111
|
<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
|
|
112
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
113
|
<p><div class=right>(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
|
|
114
114
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
115
115
|
<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
116
|
<p>Example Usage:</p>
|
|
117
|
-
<div class="language-ruby
|
|
118
|
-
<h3 class="anchor
|
|
117
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
118
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
119
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
120
120
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
121
121
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
122
122
|
<p>Example Usage:</p>
|
|
123
|
-
<div class="language-ruby
|
|
124
|
-
<h2 class="anchor
|
|
123
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
124
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
125
|
<p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
|
|
126
126
|
<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
|
-
<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
|
|
127
|
+
<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
128
|
<p>Additional parameters are required. Please see the <a href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
|
|
129
|
-
<h2 class="anchor
|
|
129
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
130
|
<p><strong>Defines a new target</strong></p>
|
|
131
131
|
<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
132
|
<p>Example Usage:</p>
|
|
133
|
-
<div class="language-ruby
|
|
134
|
-
<h2 class="anchor
|
|
133
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
134
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
135
|
<p>The following keywords must follow a TARGET keyword.</p>
|
|
136
|
-
<h3 class="anchor
|
|
136
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
137
|
<p><div class=right>(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
|
|
138
138
|
<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
|
|
139
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
140
|
<p><strong>Command binary logs can be cycled on a time interval.</strong></p>
|
|
141
141
|
<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
|
|
142
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
143
|
<p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
144
144
|
<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
|
|
145
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
146
|
<p><strong>How long to keep raw command logs in seconds.</strong></p>
|
|
147
147
|
<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
|
|
148
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
149
|
<p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
|
|
150
150
|
<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
|
|
151
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
152
|
<p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
153
153
|
<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
|
|
154
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
155
|
<p><strong>How long to keep decom command logs in seconds.</strong></p>
|
|
156
156
|
<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
|
|
157
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
158
|
<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
159
|
<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
|
|
160
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
161
|
<p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
|
|
162
162
|
<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
|
|
163
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
164
|
<p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
|
|
165
165
|
<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
|
|
166
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
167
|
<p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
|
|
168
168
|
<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
|
|
169
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
170
|
<p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
|
|
171
171
|
<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
|
|
172
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
173
|
<p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
|
|
174
174
|
<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
|
|
175
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
176
|
<p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
|
|
177
177
|
<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
|
|
178
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
179
|
<p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
|
|
180
180
|
<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
|
|
181
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
182
|
<p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
|
|
183
183
|
<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
|
|
184
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
185
|
<p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
|
|
186
186
|
<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
|
|
187
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
188
|
<p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
|
|
189
189
|
<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
|
|
190
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
191
|
<p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
|
|
192
192
|
<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
|
|
193
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
194
|
<p><strong>Period at which to run the cleanup process.</strong></p>
|
|
195
195
|
<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
|
|
196
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
197
|
<p><strong>Disables the data reduction microservice for the target</strong></p>
|
|
198
|
-
<h3 class="anchor
|
|
198
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
199
|
<p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
|
|
200
200
|
<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
|
|
201
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
202
|
<p><div class=right>(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
|
|
203
203
|
<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
204
|
<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
|
|
205
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
206
|
<p><div class=right>(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
|
|
207
207
|
<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
|
|
208
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
209
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
210
210
|
<p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
|
|
211
211
|
<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
|
|
212
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
213
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
214
214
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
215
215
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
216
216
|
<p>Example Usage:</p>
|
|
217
|
-
<div class="language-ruby
|
|
218
|
-
<h2 class="anchor
|
|
217
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
218
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
219
|
<p><strong>Defines a new microservice</strong></p>
|
|
220
220
|
<p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
|
|
221
221
|
<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
222
|
<p>Example Usage:</p>
|
|
223
|
-
<div class="language-ruby
|
|
224
|
-
<h2 class="anchor
|
|
223
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
224
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
225
|
<p>The following keywords must follow a MICROSERVICE keyword.</p>
|
|
226
|
-
<h3 class="anchor
|
|
226
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
227
|
<p><strong>Sets an environment variable in the microservice.</strong></p>
|
|
228
228
|
<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
229
|
<p>Example Usage:</p>
|
|
230
|
-
<div class="language-ruby
|
|
231
|
-
<h3 class="anchor
|
|
230
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
231
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
232
|
<p><strong>Set the working directory</strong></p>
|
|
233
233
|
<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
234
|
<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
235
|
<p>Example Usage:</p>
|
|
236
|
-
<div class="language-ruby
|
|
237
|
-
<h3 class="anchor
|
|
236
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
237
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
238
|
<p><div class=right>(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
|
|
239
239
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
240
240
|
<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
241
|
<p>Example Usage:</p>
|
|
242
|
-
<div class="language-ruby
|
|
243
|
-
<h3 class="anchor
|
|
242
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
243
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
244
|
<p><strong>Associate a Redis topic</strong></p>
|
|
245
245
|
<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
246
|
<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
247
|
<p>Example Usage:</p>
|
|
248
|
-
<div class="language-ruby
|
|
249
|
-
<h3 class="anchor
|
|
248
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
249
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
250
|
<p><strong>Associate a OpenC3 target</strong></p>
|
|
251
251
|
<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
252
|
<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
253
|
<p>Example Usage:</p>
|
|
254
|
-
<div class="language-ruby
|
|
255
|
-
<h3 class="anchor
|
|
254
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
255
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
256
|
<p><strong>Command line to execute to run the microservice.</strong></p>
|
|
257
257
|
<p>Command line to execute to run the microservice.</p>
|
|
258
258
|
<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="tabs-container
|
|
260
|
-
<h3 class="anchor
|
|
259
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
260
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
261
|
<p><strong>Pass an option to the microservice</strong></p>
|
|
262
262
|
<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
263
|
<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
|
|
264
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
265
|
<p><strong>Docker Container</strong></p>
|
|
266
266
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise.</p>
|
|
267
267
|
<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
|
|
268
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
269
|
<p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
|
|
270
270
|
<p>Defines a secret for this microservice. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
|
|
271
271
|
<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 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
272
|
<p>Example Usage:</p>
|
|
273
|
-
<div class="language-ruby
|
|
274
|
-
<h3 class="anchor
|
|
273
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
274
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
275
|
<p><div class=right>(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
|
|
276
276
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
277
277
|
<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
278
|
<p>Example Usage:</p>
|
|
279
|
-
<div class="language-ruby
|
|
280
|
-
<h3 class="anchor
|
|
279
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
280
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
281
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
282
282
|
<p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
|
|
283
283
|
<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
|
|
284
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
285
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
286
286
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
287
287
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
288
288
|
<p>Example Usage:</p>
|
|
289
|
-
<div class="language-ruby
|
|
290
|
-
<h3 class="anchor
|
|
289
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
290
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
291
|
<p><div class=right>(Since 6.2.0)</div><strong>Initially creates the microservice in a stopped state (not enabled)</strong><p></p>
|
|
292
292
|
<p>Example Usage:</p>
|
|
293
|
-
<div class="language-ruby
|
|
294
|
-
<h2 class="anchor
|
|
293
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
294
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
295
|
<p><strong>Define a tool</strong></p>
|
|
296
296
|
<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
297
|
<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
298
|
<p>Example Usage:</p>
|
|
299
|
-
<div class="language-ruby
|
|
300
|
-
<h2 class="anchor
|
|
299
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
300
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
301
|
<p>The following keywords must follow a TOOL keyword.</p>
|
|
302
|
-
<h3 class="anchor
|
|
302
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
303
|
<p><strong>Url used to access the tool</strong></p>
|
|
304
304
|
<p>The relative url used to access the tool. Defaults to "/tools/ToolFolderName".</p>
|
|
305
305
|
<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
|
|
306
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
307
|
<p><strong>Internal url to load a tool</strong></p>
|
|
308
308
|
<p>The url of the javascript file used to load the tool into single-SPA. Defaults to "main.js".</p>
|
|
309
309
|
<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
|
|
310
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
311
|
<p><strong>How to display the tool when navigated to</strong></p>
|
|
312
312
|
<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
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Window Mode<td>Tool display mode<br
|
|
314
|
-
<h3 class="anchor
|
|
313
|
+
<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 anchorWithStickyNavbar_TUrh" 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
315
|
<p><strong>Set tool icon</strong></p>
|
|
316
316
|
<p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
|
|
317
317
|
<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">https://materialdesignicons.com/</a>), and Astro.<td>True</table>
|
|
318
|
-
<h3 class="anchor
|
|
318
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
319
|
<p><strong>Category for the tool</strong></p>
|
|
320
320
|
<p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
|
|
321
321
|
<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
|
|
322
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
323
|
<p><strong>Show the tool or not</strong></p>
|
|
324
324
|
<p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
|
|
325
|
-
<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
|
|
326
|
-
<h3 class="anchor
|
|
325
|
+
<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 anchorWithStickyNavbar_TUrh" 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
327
|
<p><div class=right>(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
|
|
328
328
|
<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
329
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Position<td>Numerical position<td>True</table>
|
|
330
|
-
<h3 class="anchor
|
|
330
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
331
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
332
332
|
<p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
|
|
333
333
|
<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
|
|
334
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
335
|
<p><div class=right>(Since 6.0.0)</div><strong>Add an item to the import map</strong><p></p>
|
|
336
336
|
<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
|
|
337
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
338
|
<p><strong>Define a custom widget</strong></p>
|
|
339
339
|
<p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
|
|
340
340
|
<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 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
341
|
<p>Example Usage:</p>
|
|
342
|
-
<div class="language-ruby
|
|
343
|
-
<h2 class="anchor
|
|
342
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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>
|
|
343
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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
344
|
<p>The following keywords must follow a WIDGET keyword.</p>
|
|
345
|
-
<h3 class="anchor
|
|
345
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" 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
346
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
347
347
|
<p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
|
|
348
348
|
<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
|
|
349
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" 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>
|
|
350
350
|
<p><strong>Define a script engine to add language support to Script Runner</strong></p>
|
|
351
351
|
<p>Defines a script engine to add language support to Script Runner</p>
|
|
352
352
|
<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
353
|
<p>Example Usage:</p>
|
|
354
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token 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><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></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_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#introduction class="table-of-contents__link toc-highlight">Introduction</a><li><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-hidden=true class=iconExternalLink_awgD><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-hidden=true class=iconExternalLink_awgD><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>
|
|
354
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><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><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_CuGa 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_h4bd"></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_rhgf 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_mMqu><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_mMqu><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>
|