openc3-cosmos-tool-docs 6.4.1 → 6.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +4 -1
- data/tools/staticdocs/assets/css/styles.1a361da6.css +1 -0
- data/tools/staticdocs/assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png +0 -0
- data/tools/staticdocs/assets/images/docker-security-bb6d4bdd60a5cd7df87a572159c6369b67bee5735be5a501b25786cabdcd4228.png +0 -0
- data/tools/staticdocs/assets/images/tlm-processing-ce5d4cc16e4a19d9c4f799cc8af975e93eb1c54ba0d43acbc31cc048667b223d.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5dd06a57.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.ed3ac5fa.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ef66a55c.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.43788fd9.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.7aacaf90.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.7aa50138.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.ff33b528.js +1 -0
- data/tools/staticdocs/assets/js/13196248.14de6ce1.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.2dafa283.js +1 -0
- data/tools/staticdocs/assets/js/1602.502ef9b1.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.d99a363c.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.d91543a5.js +1 -0
- data/tools/staticdocs/assets/js/2124.545702e0.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.5eb8d876.js +1 -0
- data/tools/staticdocs/assets/js/2368.fd1bb46a.js +4 -0
- data/tools/staticdocs/assets/js/26b8abb2.021651f5.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.1eee5bcb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.7f30b517.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.4f30c5da.js +1 -0
- data/tools/staticdocs/assets/js/3687.8bc61ef3.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.dfbe9bb7.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.42b05c12.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e55efd5d.js +1 -0
- data/tools/staticdocs/assets/js/42170351.2de491d4.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.f7c95691.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.2da36c11.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.7cc2c5cc.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.29533a03.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.62d9a8b8.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.40e0caf8.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.64ea5a52.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.2d29f3fb.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.ec0009ac.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.1c205c60.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.32ded6d5.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.b2a62736.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.e0eb7741.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7719.0d312792.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.a0dfbdf7.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.32ca371f.js +1 -0
- data/tools/staticdocs/assets/js/{89e76475.e1b0dbdb.js → 89e76475.20b3a636.js} +1 -1
- data/tools/staticdocs/assets/js/8f7843ee.6d7c9cd4.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.75b12400.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.0eee94ba.js +1 -0
- data/tools/staticdocs/assets/js/97535711.630cee4d.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.73b5cd90.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.6b6404ff.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.715fc441.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.76d13f14.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.3b3e7379.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.da1da6f1.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.bc122746.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.4e8142cb.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.4a10f506.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.08749f15.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.776bc00f.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.ce400445.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.a201a4a7.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.77326c08.js +1 -0
- data/tools/staticdocs/assets/js/{c2598f55.812cdcd1.js → c2598f55.85419dc8.js} +1 -1
- data/tools/staticdocs/assets/js/cb8c3f08.73cefada.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.dc2adfcc.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.57f5e162.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.73bb876f.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.e348c06d.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.885590b1.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1143a9d4.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.0ffb9759.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.fe602968.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.a115a366.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.1aefa4e7.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.9c957b0c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.ddc630ca.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.f9c2d1fc.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.a4d98d69.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.656b4fa3.js +1 -0
- data/tools/staticdocs/assets/js/main.ba1fa268.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.ca894d1e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +21 -18
- data/tools/staticdocs/docs/configuration/command.html +35 -35
- data/tools/staticdocs/docs/configuration/conversions.html +156 -0
- data/tools/staticdocs/docs/configuration/format.html +18 -15
- data/tools/staticdocs/docs/configuration/interfaces.html +34 -31
- data/tools/staticdocs/docs/configuration/plugins.html +39 -36
- data/tools/staticdocs/docs/configuration/protocols.html +28 -25
- data/tools/staticdocs/docs/configuration/ssl-tls.html +10 -6
- data/tools/staticdocs/docs/configuration/table.html +19 -22
- data/tools/staticdocs/docs/configuration/target.html +11 -8
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +72 -69
- data/tools/staticdocs/docs/configuration/telemetry.html +40 -40
- data/tools/staticdocs/docs/configuration.html +4 -1
- data/tools/staticdocs/docs/development/curl.html +12 -9
- data/tools/staticdocs/docs/development/developing.html +15 -12
- data/tools/staticdocs/docs/development/json-api.html +8 -5
- data/tools/staticdocs/docs/development/log-structure.html +5 -2
- data/tools/staticdocs/docs/development/roadmap.html +5 -2
- data/tools/staticdocs/docs/development/streaming-api.html +13 -10
- data/tools/staticdocs/docs/development/testing.html +15 -12
- data/tools/staticdocs/docs/development.html +4 -1
- data/tools/staticdocs/docs/getting-started/cli.html +16 -13
- data/tools/staticdocs/docs/getting-started/generators.html +19 -16
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +15 -12
- data/tools/staticdocs/docs/getting-started/installation.html +7 -4
- data/tools/staticdocs/docs/getting-started/key-concepts.html +6 -3
- data/tools/staticdocs/docs/getting-started/podman.html +19 -16
- data/tools/staticdocs/docs/getting-started/requirements.html +7 -4
- data/tools/staticdocs/docs/getting-started/upgrading.html +23 -15
- data/tools/staticdocs/docs/getting-started.html +4 -1
- data/tools/staticdocs/docs/guides/bridges.html +7 -4
- data/tools/staticdocs/docs/guides/cfs.html +19 -16
- data/tools/staticdocs/docs/guides/custom-widgets.html +54 -16
- data/tools/staticdocs/docs/guides/dynamic-packets.html +9 -6
- data/tools/staticdocs/docs/guides/exposing-microservices.html +9 -6
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +6 -3
- data/tools/staticdocs/docs/guides/local-mode.html +6 -3
- data/tools/staticdocs/docs/guides/logging.html +5 -2
- data/tools/staticdocs/docs/guides/monitoring.html +11 -8
- data/tools/staticdocs/docs/guides/performance.html +6 -3
- data/tools/staticdocs/docs/guides/raspberrypi.html +6 -3
- data/tools/staticdocs/docs/guides/reference-architectures.html +35 -0
- data/tools/staticdocs/docs/guides/script-writing.html +46 -43
- data/tools/staticdocs/docs/guides/scripting-api.html +627 -433
- data/tools/staticdocs/docs/guides.html +4 -1
- data/tools/staticdocs/docs/meta/contributing.html +10 -7
- data/tools/staticdocs/docs/meta/licenses.html +6 -3
- data/tools/staticdocs/docs/meta/philosophy.html +5 -2
- data/tools/staticdocs/docs/meta/xtce.html +7 -4
- data/tools/staticdocs/docs/meta.html +4 -1
- data/tools/staticdocs/docs/privacy.html +5 -2
- data/tools/staticdocs/docs/tools/admin.html +5 -2
- data/tools/staticdocs/docs/tools/autonomic.html +5 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +5 -2
- data/tools/staticdocs/docs/tools/calendar.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +5 -2
- data/tools/staticdocs/docs/tools/command_history.html +5 -2
- data/tools/staticdocs/docs/tools/data-extractor.html +5 -2
- data/tools/staticdocs/docs/tools/data-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/handbooks.html +5 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +5 -2
- data/tools/staticdocs/docs/tools/packet-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/script-runner.html +9 -6
- data/tools/staticdocs/docs/tools/table-manager.html +6 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +5 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +5 -2
- data/tools/staticdocs/docs/tools.html +4 -1
- data/tools/staticdocs/docs.html +6 -8
- data/tools/staticdocs/img/cmd-processing.png +0 -0
- data/tools/staticdocs/img/docker-local-security.png +0 -0
- data/tools/staticdocs/img/docker-security.png +0 -0
- data/tools/staticdocs/img/tlm-processing.png +0 -0
- data/tools/staticdocs/index.html +4 -1
- data/tools/staticdocs/lunr-index-1748640055686.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +5 -2
- data/tools/staticdocs/search-doc-1748640055686.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +94 -83
- data/tools/staticdocs/assets/css/styles.1de6b959.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.43fd7635.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.5cfabd67.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.0e2ea47d.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.5515d5e3.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.7697df48.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.f81b787b.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.e7943c80.js +0 -1
- data/tools/staticdocs/assets/js/13196248.ea83002e.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.eb5250f4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.d91f6c3e.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.0df9587b.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.7f8d4cb0.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.1772f030.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.fcf47881.js +0 -1
- data/tools/staticdocs/assets/js/3969.afdd070b.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.c3455b97.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.5ed2e9b5.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.f7b3ff17.js +0 -1
- data/tools/staticdocs/assets/js/42170351.fbc05869.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.60fa883f.js +0 -1
- data/tools/staticdocs/assets/js/5205.c6f31e57.js +0 -1
- data/tools/staticdocs/assets/js/5328.3e2a53eb.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.fe331a71.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.ef91ba12.js +0 -1
- data/tools/staticdocs/assets/js/5761.e7fabbc9.js +0 -4
- data/tools/staticdocs/assets/js/5b233ba7.9d6ba314.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.8b51f7c0.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.63b46202.js +0 -1
- data/tools/staticdocs/assets/js/651.a043d7b1.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.1318b398.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.1e950fcb.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.6a77064a.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.0376a397.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.6439052e.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.b6fcfc30.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.324643a8.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.607160d3.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.27d9d599.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.abe30983.js +0 -1
- data/tools/staticdocs/assets/js/9357.9a7e89b5.js +0 -101
- data/tools/staticdocs/assets/js/9424f0b3.3683501c.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.0e04c58d.js +0 -1
- data/tools/staticdocs/assets/js/97535711.e595488c.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.841b4a2e.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.36405219.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.821f7504.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.cfa50691.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.b418f772.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.805dc1ba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.ef9b0f38.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.57d6e194.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.c648533a.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.a9228642.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.4c0bb1dd.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.8ad39448.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.0575c394.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.07d1c9e9.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.59af1749.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.da892cde.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.a58b9bbd.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.9fef8263.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.c74b62b1.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.e812e6e7.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.80a50660.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.8df86c99.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.5db8667e.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.f1eed806.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.75e9fc53.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.9e4e6681.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.d3a1e4bc.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.49804e96.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.124ffe26.js +0 -1
- data/tools/staticdocs/assets/js/main.b1edeb65.js +0 -36
- data/tools/staticdocs/assets/js/runtime~main.3629ffb4.js +0 -1
- data/tools/staticdocs/lunr-index-1747245438937.json +0 -1
- data/tools/staticdocs/search-doc-1747245438937.json +0 -1
|
@@ -1,4 +1,7 @@
|
|
|
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.7.0"><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><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.3629ffb4.js defer></script><script src=/tools/staticdocs/assets/js/main.b1edeb65.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><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 style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li 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/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 itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Plugins</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>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>
|
|
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.8.0"><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.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.ca894d1e.js defer></script><script src=/tools/staticdocs/assets/js/main.ba1fa268.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
|
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
|
+
</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/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>
|
|
2
5
|
<p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
|
|
3
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>
|
|
4
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>
|
|
@@ -36,23 +39,23 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
36
39
|
<p><strong>Maps a target name to an interface</strong></p>
|
|
37
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>
|
|
38
41
|
<p>Ruby Example:</p>
|
|
39
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
42
|
+
<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)">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>
|
|
40
43
|
<p>Python Example:</p>
|
|
41
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
44
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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>
|
|
42
45
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
43
46
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
|
|
44
47
|
<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
48
|
<p>Ruby Example:</p>
|
|
46
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
49
|
+
<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)">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>
|
|
47
50
|
<p>Python Example:</p>
|
|
48
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
51
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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>
|
|
49
52
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
50
53
|
<p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
|
|
51
54
|
<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>
|
|
52
55
|
<p>Ruby Example:</p>
|
|
53
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
56
|
+
<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)">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>
|
|
54
57
|
<p>Python Example:</p>
|
|
55
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
58
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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>
|
|
56
59
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
57
60
|
<p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
|
|
58
61
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
@@ -71,52 +74,52 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
71
74
|
<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>
|
|
72
75
|
<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>
|
|
73
76
|
<p>Example Usage:</p>
|
|
74
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
77
|
+
<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)">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>
|
|
75
78
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=protocol>PROTOCOL<a href=#protocol class=hash-link aria-label="Direct link to PROTOCOL" title="Direct link to PROTOCOL"></a></h3>
|
|
76
79
|
<p><div class=right>(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
|
|
77
80
|
<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>
|
|
78
81
|
<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>
|
|
79
82
|
<p>Ruby Example:</p>
|
|
80
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
83
|
+
<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)">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>
|
|
81
84
|
<p>Python Example:</p>
|
|
82
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
85
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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 IgnorePacketProtocol 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>
|
|
83
86
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=option>OPTION<a href=#option class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION"></a></h3>
|
|
84
87
|
<p><strong>Set a parameter on an interface</strong></p>
|
|
85
88
|
<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>
|
|
86
89
|
<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>
|
|
87
90
|
<p>Example Usage:</p>
|
|
88
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
91
|
+
<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)">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>
|
|
89
92
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=secret>SECRET<a href=#secret class=hash-link aria-label="Direct link to SECRET" title="Direct link to SECRET"></a></h3>
|
|
90
93
|
<p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
|
|
91
94
|
<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>
|
|
92
95
|
<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>
|
|
93
96
|
<p>Example Usage:</p>
|
|
94
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
97
|
+
<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)">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>
|
|
95
98
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=env>ENV<a href=#env class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV"></a></h3>
|
|
96
99
|
<p><div class=right>(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
|
|
97
100
|
<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>
|
|
98
101
|
<p>Example Usage:</p>
|
|
99
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
102
|
+
<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)">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>
|
|
100
103
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
101
104
|
<p><div class=right>(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
|
|
102
105
|
<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>
|
|
103
106
|
<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>
|
|
104
107
|
<p>Example Usage:</p>
|
|
105
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
108
|
+
<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)">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>
|
|
106
109
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=port>PORT<a href=#port class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT"></a></h3>
|
|
107
110
|
<p><div class=right>(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
|
|
108
111
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
109
112
|
<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>
|
|
110
113
|
<p>Example Usage:</p>
|
|
111
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
114
|
+
<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)">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>
|
|
112
115
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd>CMD<a href=#cmd class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD"></a></h3>
|
|
113
116
|
<p><div class=right>(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
|
|
114
117
|
<p>Command line to execute to run the microservice.</p>
|
|
115
118
|
<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>
|
|
116
119
|
<p>Ruby Example:</p>
|
|
117
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
120
|
+
<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)">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>
|
|
118
121
|
<p>Python Example:</p>
|
|
119
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
122
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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>
|
|
120
123
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=container>CONTAINER<a href=#container class=hash-link aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER"></a></h3>
|
|
121
124
|
<p><div class=right>(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
|
|
122
125
|
<p>Container to execute and run the microservice in. Only used in COSMOS Enterprise.</p>
|
|
@@ -126,13 +129,13 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
126
129
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
127
130
|
<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>
|
|
128
131
|
<p>Example Usage:</p>
|
|
129
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
132
|
+
<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)">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>
|
|
130
133
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=shard>SHARD<a href=#shard class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD"></a></h3>
|
|
131
134
|
<p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
|
|
132
135
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
133
136
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
134
137
|
<p>Example Usage:</p>
|
|
135
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
138
|
+
<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)">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>
|
|
136
139
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=router-1>ROUTER<a href=#router-1 class=hash-link aria-label="Direct link to ROUTER" title="Direct link to ROUTER"></a></h2>
|
|
137
140
|
<p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
|
|
138
141
|
<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>
|
|
@@ -142,7 +145,7 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
142
145
|
<p><strong>Defines a new target</strong></p>
|
|
143
146
|
<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>
|
|
144
147
|
<p>Example Usage:</p>
|
|
145
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
148
|
+
<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)">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>
|
|
146
149
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
147
150
|
<p>The following keywords must follow a TARGET keyword.</p>
|
|
148
151
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
@@ -226,52 +229,52 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
226
229
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
227
230
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
228
231
|
<p>Example Usage:</p>
|
|
229
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
232
|
+
<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)">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>
|
|
230
233
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=microservice-1>MICROSERVICE<a href=#microservice-1 class=hash-link aria-label="Direct link to MICROSERVICE" title="Direct link to MICROSERVICE"></a></h2>
|
|
231
234
|
<p><strong>Defines a new microservice</strong></p>
|
|
232
235
|
<p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
|
|
233
236
|
<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>
|
|
234
237
|
<p>Example Usage:</p>
|
|
235
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
238
|
+
<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)">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>
|
|
236
239
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
237
240
|
<p>The following keywords must follow a MICROSERVICE keyword.</p>
|
|
238
241
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=env-1>ENV<a href=#env-1 class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV"></a></h3>
|
|
239
242
|
<p><strong>Sets an environment variable in the microservice.</strong></p>
|
|
240
243
|
<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>
|
|
241
244
|
<p>Example Usage:</p>
|
|
242
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
245
|
+
<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)">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>
|
|
243
246
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
244
247
|
<p><strong>Set the working directory</strong></p>
|
|
245
248
|
<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>
|
|
246
249
|
<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>
|
|
247
250
|
<p>Example Usage:</p>
|
|
248
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
251
|
+
<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)">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>
|
|
249
252
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=port-1>PORT<a href=#port-1 class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT"></a></h3>
|
|
250
253
|
<p><div class=right>(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
|
|
251
254
|
<p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
|
|
252
255
|
<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>
|
|
253
256
|
<p>Example Usage:</p>
|
|
254
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
257
|
+
<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)">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>
|
|
255
258
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=topic>TOPIC<a href=#topic class=hash-link aria-label="Direct link to TOPIC" title="Direct link to TOPIC"></a></h3>
|
|
256
259
|
<p><strong>Associate a Redis topic</strong></p>
|
|
257
260
|
<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>
|
|
258
261
|
<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>
|
|
259
262
|
<p>Example Usage:</p>
|
|
260
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
263
|
+
<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)">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>
|
|
261
264
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
262
265
|
<p><strong>Associate a OpenC3 target</strong></p>
|
|
263
266
|
<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>
|
|
264
267
|
<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>
|
|
265
268
|
<p>Example Usage:</p>
|
|
266
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
269
|
+
<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)">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>
|
|
267
270
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd-1>CMD<a href=#cmd-1 class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD"></a></h3>
|
|
268
271
|
<p><strong>Command line to execute to run the microservice.</strong></p>
|
|
269
272
|
<p>Command line to execute to run the microservice.</p>
|
|
270
273
|
<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>
|
|
271
274
|
<p>Ruby Example:</p>
|
|
272
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
275
|
+
<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)">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>
|
|
273
276
|
<p>Python Example:</p>
|
|
274
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
277
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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>
|
|
275
278
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=option-1>OPTION<a href=#option-1 class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION"></a></h3>
|
|
276
279
|
<p><strong>Pass an option to the microservice</strong></p>
|
|
277
280
|
<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>
|
|
@@ -285,13 +288,13 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
285
288
|
<p>Defines a secret for this microservice. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
|
|
286
289
|
<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>
|
|
287
290
|
<p>Example Usage:</p>
|
|
288
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
291
|
+
<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)">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>
|
|
289
292
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
290
293
|
<p><div class=right>(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
|
|
291
294
|
<p>Prefix of route to the microservice to expose externally with Traefik</p>
|
|
292
295
|
<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>
|
|
293
296
|
<p>Example Usage:</p>
|
|
294
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
297
|
+
<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)">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>
|
|
295
298
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
296
299
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
297
300
|
<p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
|
|
@@ -301,17 +304,17 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
301
304
|
<p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
|
|
302
305
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
|
|
303
306
|
<p>Example Usage:</p>
|
|
304
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
307
|
+
<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)">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>
|
|
305
308
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=stopped>STOPPED<a href=#stopped class=hash-link aria-label="Direct link to STOPPED" title="Direct link to STOPPED"></a></h3>
|
|
306
309
|
<p><div class=right>(Since 6.2.0)</div><strong>Initially creates the microservice in a stopped state (not enabled)</strong><p></p>
|
|
307
310
|
<p>Example Usage:</p>
|
|
308
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
311
|
+
<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)">STOPPED</span><br></span></code></pre></div></div>
|
|
309
312
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=tool-1>TOOL<a href=#tool-1 class=hash-link aria-label="Direct link to TOOL" title="Direct link to TOOL"></a></h2>
|
|
310
313
|
<p><strong>Define a tool</strong></p>
|
|
311
314
|
<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>
|
|
312
315
|
<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>
|
|
313
316
|
<p>Example Usage:</p>
|
|
314
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
317
|
+
<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)">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>
|
|
315
318
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
316
319
|
<p>The following keywords must follow a TOOL keyword.</p>
|
|
317
320
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=url>URL<a href=#url class=hash-link aria-label="Direct link to URL" title="Direct link to URL"></a></h3>
|
|
@@ -354,10 +357,10 @@ This file follows the standard COSMOS configuration file format of keywords foll
|
|
|
354
357
|
<p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
|
|
355
358
|
<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>
|
|
356
359
|
<p>Example Usage:</p>
|
|
357
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
|
360
|
+
<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)">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>
|
|
358
361
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
359
362
|
<p>The following keywords must follow a WIDGET keyword.</p>
|
|
360
363
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
361
364
|
<p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
|
|
362
365
|
<p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
|
|
363
|
-
<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></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="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/format><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/target><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Targets</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#introduction class="table-of-contents__link toc-highlight">Introduction</a><li><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></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
|
366
|
+
<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></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></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>
|