openc3-cosmos-tool-docs 5.17.1 → 5.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +4 -4
  3. data/tools/staticdocs/assets/css/{styles.8a0f1b26.css → styles.80ddca08.css} +1 -1
  4. data/tools/staticdocs/assets/js/{019369f3.34291acc.js → 019369f3.727d87f1.js} +1 -1
  5. data/tools/staticdocs/assets/js/{058ffc22.8d9049f4.js → 058ffc22.f2d69d72.js} +1 -1
  6. data/tools/staticdocs/assets/js/{0686a885.dde7b18b.js → 0686a885.83641127.js} +1 -1
  7. data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +1 -0
  8. data/tools/staticdocs/assets/js/{0f5d161c.ca02c5b2.js → 0f5d161c.e26d88b8.js} +1 -1
  9. data/tools/staticdocs/assets/js/{0ff569c9.ad025a56.js → 0ff569c9.aa4daee5.js} +1 -1
  10. data/tools/staticdocs/assets/js/{103cc3be.6b6cd0fa.js → 103cc3be.78f97eb1.js} +1 -1
  11. data/tools/staticdocs/assets/js/{13196248.9e7794e3.js → 13196248.ca2e8950.js} +1 -1
  12. data/tools/staticdocs/assets/js/{13c1b4e4.cec67b9c.js → 13c1b4e4.22a0b1d4.js} +1 -1
  13. data/tools/staticdocs/assets/js/{2047b354.bdd2586a.js → 2047b354.25d11993.js} +1 -1
  14. data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +1 -0
  15. data/tools/staticdocs/assets/js/{2bb7bf90.043455de.js → 2bb7bf90.fa05d998.js} +1 -1
  16. data/tools/staticdocs/assets/js/3917.1ec7d126.js +1 -0
  17. data/tools/staticdocs/assets/js/{3dd7ef3b.c7c1d93f.js → 3dd7ef3b.d55880a8.js} +1 -1
  18. data/tools/staticdocs/assets/js/{40365d27.7eb3f7b1.js → 40365d27.4b4b2ccd.js} +1 -1
  19. data/tools/staticdocs/assets/js/{411898ad.d5f62a27.js → 411898ad.1d6a609d.js} +1 -1
  20. data/tools/staticdocs/assets/js/{42170351.69a8ed02.js → 42170351.c68b85e1.js} +1 -1
  21. data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +1 -0
  22. data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +1 -0
  23. data/tools/staticdocs/assets/js/{54d0d530.28ba5be7.js → 54d0d530.d3f9a4ac.js} +1 -1
  24. data/tools/staticdocs/assets/js/{5b233ba7.9c621552.js → 5b233ba7.6fdd6b6c.js} +1 -1
  25. data/tools/staticdocs/assets/js/{5bc719f6.7fa17221.js → 5bc719f6.daa2a049.js} +1 -1
  26. data/tools/staticdocs/assets/js/{5c6ce5ec.5e6ca46b.js → 5c6ce5ec.61a9cae2.js} +1 -1
  27. data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +1 -0
  28. data/tools/staticdocs/assets/js/5fe211ef.a9f21277.js +1 -0
  29. data/tools/staticdocs/assets/js/6831b732.185eb427.js +1 -0
  30. data/tools/staticdocs/assets/js/{696b4199.0335bd94.js → 696b4199.a5ae3d65.js} +1 -1
  31. data/tools/staticdocs/assets/js/{6b210247.2cbd59e6.js → 6b210247.e96f3982.js} +1 -1
  32. data/tools/staticdocs/assets/js/{6b65133b.87dc7da6.js → 6b65133b.4e84b1c2.js} +1 -1
  33. data/tools/staticdocs/assets/js/6f92e431.65aa0240.js +1 -0
  34. data/tools/staticdocs/assets/js/72c6d8a8.98daa27a.js +1 -0
  35. data/tools/staticdocs/assets/js/{75e64983.932fbc0e.js → 75e64983.6ef0928b.js} +1 -1
  36. data/tools/staticdocs/assets/js/{867640d5.ffd4cf4c.js → 867640d5.48133ad5.js} +1 -1
  37. data/tools/staticdocs/assets/js/{89e76475.97389cc5.js → 89e76475.13ce283b.js} +1 -1
  38. data/tools/staticdocs/assets/js/{8f7843ee.d1ffd5ee.js → 8f7843ee.7a68246a.js} +1 -1
  39. data/tools/staticdocs/assets/js/9424f0b3.61c6bd97.js +1 -0
  40. data/tools/staticdocs/assets/js/{97535711.fc45ced1.js → 97535711.5311ddd9.js} +1 -1
  41. data/tools/staticdocs/assets/js/{99581c43.8e571df8.js → 99581c43.527aab44.js} +1 -1
  42. data/tools/staticdocs/assets/js/{9fb6059a.42881e94.js → 9fb6059a.a5107afb.js} +1 -1
  43. data/tools/staticdocs/assets/js/{a507c363.04b98d2c.js → a507c363.d2cc5d72.js} +1 -1
  44. data/tools/staticdocs/assets/js/{a677c089.b2928bac.js → a677c089.abc52ace.js} +1 -1
  45. data/tools/staticdocs/assets/js/{a9987364.8f065f19.js → a9987364.5ef1644f.js} +1 -1
  46. data/tools/staticdocs/assets/js/{aa6b6c1b.d78e5212.js → aa6b6c1b.c51c044d.js} +1 -1
  47. data/tools/staticdocs/assets/js/{b4596165.6806d46b.js → b4596165.daa24b72.js} +1 -1
  48. data/tools/staticdocs/assets/js/b6d70f94.4923c793.js +1 -0
  49. data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +1 -0
  50. data/tools/staticdocs/assets/js/{bd0034eb.b4e3d6c1.js → bd0034eb.6691ccc4.js} +1 -1
  51. data/tools/staticdocs/assets/js/c24eae19.251e0038.js +1 -0
  52. data/tools/staticdocs/assets/js/{cb8c3f08.a0ef4b5f.js → cb8c3f08.b82ad06f.js} +1 -1
  53. data/tools/staticdocs/assets/js/cd879be4.f956406f.js +1 -0
  54. data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +1 -0
  55. data/tools/staticdocs/assets/js/{d1bfc316.2d823a88.js → d1bfc316.0a5ff560.js} +1 -1
  56. data/tools/staticdocs/assets/js/{d24bf9b6.53eca5e8.js → d24bf9b6.6c422113.js} +1 -1
  57. data/tools/staticdocs/assets/js/{d57a4b5d.aaa48891.js → d57a4b5d.8f23a506.js} +1 -1
  58. data/tools/staticdocs/assets/js/{d5d77c37.be6fe7b6.js → d5d77c37.70fdbbc6.js} +1 -1
  59. data/tools/staticdocs/assets/js/{d8ca4191.c6632184.js → d8ca4191.2349d796.js} +1 -1
  60. data/tools/staticdocs/assets/js/{d9b92eba.c6a2c7e5.js → d9b92eba.8f82360d.js} +1 -1
  61. data/tools/staticdocs/assets/js/{db8fa1d0.f078bc02.js → db8fa1d0.8f1b2c9f.js} +1 -1
  62. data/tools/staticdocs/assets/js/{dc5f7beb.a4afe7cd.js → dc5f7beb.e3a82d1e.js} +1 -1
  63. data/tools/staticdocs/assets/js/{e501b0d1.d108a8a9.js → e501b0d1.0b407477.js} +1 -1
  64. data/tools/staticdocs/assets/js/ebec1ccb.9bea92b0.js +1 -0
  65. data/tools/staticdocs/assets/js/f15615f1.5c433923.js +1 -0
  66. data/tools/staticdocs/assets/js/{fd886806.a21dd400.js → fd886806.4a41fa80.js} +1 -1
  67. data/tools/staticdocs/assets/js/main.b5390098.js +2 -0
  68. data/tools/staticdocs/assets/js/runtime~main.12d1e41d.js +1 -0
  69. data/tools/staticdocs/docs/configuration/command.html +96 -180
  70. data/tools/staticdocs/docs/configuration/format.html +25 -54
  71. data/tools/staticdocs/docs/configuration/interfaces.html +25 -80
  72. data/tools/staticdocs/docs/configuration/plugins.html +138 -178
  73. data/tools/staticdocs/docs/configuration/protocols.html +91 -110
  74. data/tools/staticdocs/docs/configuration/ssl-tls.html +33 -104
  75. data/tools/staticdocs/docs/configuration/table.html +67 -125
  76. data/tools/staticdocs/docs/configuration/target.html +23 -31
  77. data/tools/staticdocs/docs/configuration/telemetry-screens.html +194 -455
  78. data/tools/staticdocs/docs/configuration/telemetry.html +104 -187
  79. data/tools/staticdocs/docs/configuration.html +4 -4
  80. data/tools/staticdocs/docs/development/curl.html +17 -126
  81. data/tools/staticdocs/docs/development/developing.html +29 -80
  82. data/tools/staticdocs/docs/development/host-install.html +10 -23
  83. data/tools/staticdocs/docs/development/json-api.html +20 -32
  84. data/tools/staticdocs/docs/development/log-structure.html +14 -14
  85. data/tools/staticdocs/docs/development/roadmap.html +15 -15
  86. data/tools/staticdocs/docs/development/streaming-api.html +11 -83
  87. data/tools/staticdocs/docs/development/testing.html +17 -26
  88. data/tools/staticdocs/docs/development.html +4 -4
  89. data/tools/staticdocs/docs/getting-started/generators.html +35 -109
  90. data/tools/staticdocs/docs/getting-started/gettingstarted.html +26 -74
  91. data/tools/staticdocs/docs/getting-started/installation.html +24 -35
  92. data/tools/staticdocs/docs/getting-started/key_concepts.html +35 -35
  93. data/tools/staticdocs/docs/getting-started/podman.html +26 -57
  94. data/tools/staticdocs/docs/getting-started/requirements.html +21 -21
  95. data/tools/staticdocs/docs/getting-started/upgrading.html +12 -17
  96. data/tools/staticdocs/docs/getting-started.html +4 -4
  97. data/tools/staticdocs/docs/guides/bridges.html +19 -63
  98. data/tools/staticdocs/docs/guides/cfs.html +44 -184
  99. data/tools/staticdocs/docs/guides/custom-widgets.html +20 -47
  100. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +5 -14
  101. data/tools/staticdocs/docs/guides/local-mode.html +16 -21
  102. data/tools/staticdocs/docs/guides/logging.html +12 -12
  103. data/tools/staticdocs/docs/guides/monitoring.html +22 -137
  104. data/tools/staticdocs/docs/guides/performance.html +18 -27
  105. data/tools/staticdocs/docs/guides/raspberrypi.html +10 -23
  106. data/tools/staticdocs/docs/guides/script-writing.html +85 -391
  107. data/tools/staticdocs/docs/guides/scripting-api.html +482 -1353
  108. data/tools/staticdocs/docs/guides.html +4 -4
  109. data/tools/staticdocs/docs/meta/contributing.html +14 -19
  110. data/tools/staticdocs/docs/meta/licenses.html +13 -31
  111. data/tools/staticdocs/docs/meta/philosophy.html +4 -4
  112. data/tools/staticdocs/docs/meta/xtce.html +15 -17
  113. data/tools/staticdocs/docs/meta.html +4 -4
  114. data/tools/staticdocs/docs/privacy.html +20 -20
  115. data/tools/staticdocs/docs/tools/autonomic.html +22 -22
  116. data/tools/staticdocs/docs/tools/bucket-explorer.html +13 -13
  117. data/tools/staticdocs/docs/tools/calendar.html +21 -21
  118. data/tools/staticdocs/docs/tools/cmd-sender.html +16 -16
  119. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +23 -23
  120. data/tools/staticdocs/docs/tools/data-extractor.html +27 -27
  121. data/tools/staticdocs/docs/tools/data-viewer.html +13 -13
  122. data/tools/staticdocs/docs/tools/handbooks.html +7 -7
  123. data/tools/staticdocs/docs/tools/limits-monitor.html +19 -19
  124. data/tools/staticdocs/docs/tools/packet-viewer.html +16 -16
  125. data/tools/staticdocs/docs/tools/script-runner.html +36 -75
  126. data/tools/staticdocs/docs/tools/table-manager.html +13 -48
  127. data/tools/staticdocs/docs/tools/tlm-grapher.html +23 -23
  128. data/tools/staticdocs/docs/tools/tlm-viewer.html +18 -18
  129. data/tools/staticdocs/docs/tools.html +4 -4
  130. data/tools/staticdocs/docs.html +14 -14
  131. data/tools/staticdocs/index.html +4 -4
  132. data/tools/staticdocs/lunr-index-1724101625047.json +1 -0
  133. data/tools/staticdocs/lunr-index.json +1 -1
  134. data/tools/staticdocs/markdown-page.html +5 -5
  135. data/tools/staticdocs/search-doc-1724101625047.json +1 -0
  136. data/tools/staticdocs/search-doc.json +1 -1
  137. metadata +71 -71
  138. data/tools/staticdocs/assets/js/078dbab0.b275e04c.js +0 -1
  139. data/tools/staticdocs/assets/js/22b3ac48.0f4fbe9d.js +0 -1
  140. data/tools/staticdocs/assets/js/43652efd.be2c1d02.js +0 -1
  141. data/tools/staticdocs/assets/js/4650.292aca67.js +0 -1
  142. data/tools/staticdocs/assets/js/53ca7c5b.3f1245d5.js +0 -1
  143. data/tools/staticdocs/assets/js/5e3ed378.77db7b87.js +0 -1
  144. data/tools/staticdocs/assets/js/5fe211ef.71dc8326.js +0 -1
  145. data/tools/staticdocs/assets/js/6831b732.5714d508.js +0 -1
  146. data/tools/staticdocs/assets/js/6f92e431.300a9857.js +0 -1
  147. data/tools/staticdocs/assets/js/72c6d8a8.cfccace6.js +0 -1
  148. data/tools/staticdocs/assets/js/9424f0b3.29299bde.js +0 -1
  149. data/tools/staticdocs/assets/js/b6d70f94.f5514e8b.js +0 -1
  150. data/tools/staticdocs/assets/js/b9f60ba6.c3b3046d.js +0 -1
  151. data/tools/staticdocs/assets/js/c24eae19.6b084c7c.js +0 -1
  152. data/tools/staticdocs/assets/js/cd879be4.6f19050a.js +0 -1
  153. data/tools/staticdocs/assets/js/d1b923aa.3f3e186d.js +0 -1
  154. data/tools/staticdocs/assets/js/ebec1ccb.1ded1149.js +0 -1
  155. data/tools/staticdocs/assets/js/f15615f1.f9b655a6.js +0 -1
  156. data/tools/staticdocs/assets/js/main.c2e2b617.js +0 -2
  157. data/tools/staticdocs/assets/js/runtime~main.2bb31799.js +0 -1
  158. data/tools/staticdocs/lunr-index-1719505302032.json +0 -1
  159. data/tools/staticdocs/search-doc-1719505302032.json +0 -1
  160. /data/tools/staticdocs/assets/js/{main.c2e2b617.js.LICENSE.txt → main.b5390098.js.LICENSE.txt} +0 -0
data/tools/staticdocs/docs/configuration/plugins.html CHANGED
@@ -2,389 +2,349 @@
2
2
  <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">
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.4.0">
6
- <title data-rh="true">Plugins | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.2bb31799.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.c2e2b617.js" defer="defer"></script>
5
+ <meta name="generator" content="Docusaurus v3.5.2">
6
+ <title data-rh="true">Plugins | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.12d1e41d.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.b5390098.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 id="introduction">Introduction</h2>
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 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>
12
12
  <p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
13
13
  <p>Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality.</p>
14
14
  <p>Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains.</p>
15
- <h2 id="concepts">Concepts</h2>
16
- <h3 id="target">Target</h3>
15
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="concepts">Concepts<a href="#concepts" class="hash-link" aria-label="Direct link to Concepts" title="Direct link to Concepts">​</a></h2>
16
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="target">Target<a href="#target" class="hash-link" aria-label="Direct link to Target" title="Direct link to Target">​</a></h3>
17
17
  <p>Targets are the external pieces of hardware and/or software that COSMOS communicates with. These are things like Front End Processors (FEPs), ground support equipment (GSE), custom software tools, and pieces of hardware like satellites themselves. A target is anything that COSMOS can send commands to and receive telemetry from.</p>
18
- <h3 id="interface">Interface</h3>
18
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="interface">Interface<a href="#interface" class="hash-link" aria-label="Direct link to Interface" title="Direct link to Interface">​</a></h3>
19
19
  <p>Interfaces implement the physical connection to one or more targets. They are typically ethernet connections implemented using TCP or UDP but can be other connections like serial ports. Interfaces send commands to targets and receive telemetry from targets.</p>
20
- <h3 id="router">Router</h3>
20
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="router">Router<a href="#router" class="hash-link" aria-label="Direct link to Router" title="Direct link to Router">​</a></h3>
21
21
  <p>Routers flow streams of telemetry packets out of COSMOS and receive streams of commands into COSMOS. The commands are forwarded by COSMOS to associated interfaces. Telemetry comes from associated interfaces.</p>
22
- <h3 id="tool">Tool</h3>
22
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tool">Tool<a href="#tool" class="hash-link" aria-label="Direct link to Tool" title="Direct link to Tool">​</a></h3>
23
23
  <p>COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts.</p>
24
- <h3 id="microservice">Microservice</h3>
24
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="microservice">Microservice<a href="#microservice" class="hash-link" aria-label="Direct link to Microservice" title="Direct link to Microservice">​</a></h3>
25
25
  <p>Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks.</p>
26
- <h2 id="plugin-directory-structure">Plugin Directory Structure</h2>
27
- <p>COSMOS plugins have a well-defined directory structure described in detail in the <a href="../getting-started/generators">Code Generator</a> documentation.</p>
28
- <h2 id="plugintxt-configuration-file">plugin.txt Configuration File</h2>
26
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="plugin-directory-structure">Plugin Directory Structure<a href="#plugin-directory-structure" class="hash-link" aria-label="Direct link to Plugin Directory Structure" title="Direct link to Plugin Directory Structure">​</a></h2>
27
+ <p>COSMOS plugins have a well-defined directory structure described in detail in the <a href="/tools/staticdocs/docs/getting-started/generators">Code Generator</a> documentation.</p>
28
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="plugintxt-configuration-file">plugin.txt Configuration File<a href="#plugintxt-configuration-file" class="hash-link" aria-label="Direct link to plugin.txt Configuration File" title="Direct link to plugin.txt Configuration File">​</a></h2>
29
29
  <p>A plugin.txt configuration file is required for any COSMOS plugin. It declares the contents of the plugin and provides variables that allow the plugin to be configured at the time it is initially installed or upgraded.
30
30
  This file follows the standard COSMOS configuration file format of keywords followed by zero or more space separated parameters. The following keywords are supported by the plugin.txt config file:</p>
31
- <h2 id="variable">VARIABLE</h2>
31
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="variable">VARIABLE<a href="#variable" class="hash-link" aria-label="Direct link to VARIABLE" title="Direct link to VARIABLE">​</a></h2>
32
32
  <p><strong>Define a configurable variable for the plugin</strong></p>
33
33
  <p>The VARIABLE keyword defines a variable that will be requested for the user to enter during plugin installation. Variables can be used to handle details of targets that are user defined such as specific IP addresses and ports. Variables should also be used to allow users to rename targets to whatever name they want and support multiple installations of the same target with different names. Variables can be used later in plugin.txt or in any other configuration file included in a plugin using Ruby ERB syntax. The variables are assigned to accessible local variables in the file. At a high level, ERB allows you to run Ruby code in configuration files.</p>
34
34
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Variable Name</td><td>The name of the variable</td><td>True</td></tr><tr><td>Default Value</td><td>Default value of the variable</td><td>True</td></tr></tbody></table>
35
- <h2 id="needs_dependencies">NEEDS_DEPENDENCIES</h2>
35
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="needs_dependencies">NEEDS_DEPENDENCIES<a href="#needs_dependencies" class="hash-link" aria-label="Direct link to NEEDS_DEPENDENCIES" title="Direct link to NEEDS_DEPENDENCIES">​</a></h2>
36
36
  <p></p><div class="right">(Since 5.5.0)</div><strong>Indicates the plugin needs dependencies and sets the GEM_HOME environment variable</strong><p></p>
37
37
  <p>If the plugin has a top level lib folder or lists runtime dependencies in the gemspec, NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod.</p>
38
- <h2 id="interface-1">INTERFACE</h2>
38
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="interface-1">INTERFACE<a href="#interface-1" class="hash-link" aria-label="Direct link to INTERFACE" title="Direct link to INTERFACE">​</a></h2>
39
39
  <p><strong>Defines a connection to a physical target</strong></p>
40
- <p>Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol.</p>
41
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Interface Name</td><td>Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with &#x27;_INT&#x27; appended to the name, e.g. INST_INT for the INST target.</td><td>True</td></tr><tr><td>Filename</td><td>Ruby file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb</span></td><td>True</td></tr></tbody></table>
40
+ <p>Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby or Python file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol.</p>
41
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Interface Name</td><td>Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with &#x27;_INT&#x27; appended to the name, e.g. INST_INT for the INST target.</td><td>True</td></tr><tr><td>Filename</td><td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span></td><td>True</td></tr></tbody></table>
42
42
  <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
43
- <h2 id="interface-modifiers">INTERFACE Modifiers</h2>
43
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="interface-modifiers">INTERFACE Modifiers<a href="#interface-modifiers" class="hash-link" aria-label="Direct link to INTERFACE Modifiers" title="Direct link to INTERFACE Modifiers">​</a></h2>
44
44
  <p>The following keywords must follow a INTERFACE keyword.</p>
45
- <h3 id="map_target">MAP_TARGET</h3>
45
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="map_target">MAP_TARGET<a href="#map_target" class="hash-link" aria-label="Direct link to MAP_TARGET" title="Direct link to MAP_TARGET">​</a></h3>
46
46
  <p><strong>Maps a target name to an interface</strong></p>
47
47
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target name to map to this interface</td><td>True</td></tr></tbody></table>
48
- <p>Example Usage:</p>
49
- <pre><code class="language-ruby">INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
50
- MAP_TARGET DATA
51
- </code></pre>
52
- <h3 id="map_cmd_target">MAP_CMD_TARGET</h3>
48
+ <p>Ruby Example:</p>
49
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
50
+ <p>Python Example:</p>
51
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
52
+ <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>
53
53
  <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
54
54
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Command target name to map to this interface</td><td>True</td></tr></tbody></table>
55
- <p>Example Usage:</p>
56
- <pre><code class="language-ruby">INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
57
- MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
58
- </code></pre>
59
- <h3 id="map_tlm_target">MAP_TLM_TARGET</h3>
55
+ <p>Ruby Example:</p>
56
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
57
+ <p>Python Example:</p>
58
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
59
+ <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>
60
60
  <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
61
61
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Telemetry target name to map to this interface</td><td>True</td></tr></tbody></table>
62
- <p>Example Usage:</p>
63
- <pre><code class="language-ruby">INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
64
- MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
65
- </code></pre>
66
- <h3 id="dont_connect">DONT_CONNECT</h3>
62
+ <p>Ruby Example:</p>
63
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
64
+ <p>Python Example:</p>
65
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
66
+ <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>
67
67
  <p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
68
- <h3 id="dont_reconnect">DONT_RECONNECT</h3>
68
+ <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>
69
69
  <p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
70
- <h3 id="reconnect_delay">RECONNECT_DELAY</h3>
70
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reconnect_delay">RECONNECT_DELAY<a href="#reconnect_delay" class="hash-link" aria-label="Direct link to RECONNECT_DELAY" title="Direct link to RECONNECT_DELAY">​</a></h3>
71
71
  <p><strong>Reconnect delay in seconds</strong></p>
72
72
  <p>If DONT_RECONNECT is not present the Server will try to reconnect to an interface if the connection is lost. Reconnect delay sets the interval in seconds between reconnect tries.</p>
73
73
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Delay</td><td>Delay in seconds between reconnect attempts. The default is 15 seconds.</td><td>True</td></tr></tbody></table>
74
- <h3 id="disable_disconnect">DISABLE_DISCONNECT</h3>
74
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_disconnect">DISABLE_DISCONNECT<a href="#disable_disconnect" class="hash-link" aria-label="Direct link to DISABLE_DISCONNECT" title="Direct link to DISABLE_DISCONNECT">​</a></h3>
75
75
  <p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
76
76
  <p>Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a &#x27;production&#x27; environment where you would not want the user to inadvertantly disconnect from a target.</p>
77
- <h3 id="log_raw">LOG_RAW</h3>
77
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_raw">LOG_RAW<a href="#log_raw" class="hash-link" aria-label="Direct link to LOG_RAW" title="Direct link to LOG_RAW">​</a></h3>
78
78
  <p><strong>Deprecated, use LOG_STREAM</strong></p>
79
- <h3 id="log_stream">LOG_STREAM</h3>
79
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_stream">LOG_STREAM<a href="#log_stream" class="hash-link" aria-label="Direct link to LOG_STREAM" title="Direct link to LOG_STREAM">​</a></h3>
80
80
  <p></p><div class="right">(Since 5.5.2)</div><strong>Log all data on the interface exactly as it is sent and received</strong><p></p>
81
81
  <p>LOG_STREAM does not add any OpenC3 headers and thus can not be read by OpenC3 tools. It is primarily useful for low level debugging of an interface. You will have to manually parse these logs yourself using a hex editor or other application.</p>
82
82
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Cycle Time</td><td>Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute.</td><td>False</td></tr><tr><td>Cycle Size</td><td>Amount of data to write before cycling the log file. Default is 50MB.</td><td>False</td></tr><tr><td>Cycle Hour</td><td>The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil.</td><td>False</td></tr><tr><td>Cycle Minute</td><td>See Cycle Hour.</td><td>False</td></tr></tbody></table>
83
83
  <p>Example Usage:</p>
84
- <pre><code class="language-ruby">INTERFACE EXAMPLE example_interface.rb
85
- # Override the default log time of 600
86
- LOG_STREAM 60
87
- </code></pre>
88
- <h3 id="protocol">PROTOCOL</h3>
84
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
85
+ <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>
89
86
  <p></p><div class="right">(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
90
87
  <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>
91
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>Whether to apply the protocol on incoming data, outgoing data, or both<br><br>Valid Values: <span class="values">READ, WRITE, READ_WRITE</span></td><td>True</td></tr><tr><td>Protocol Filename or Classname</td><td>Ruby filename or class name which implements the protocol</td><td>True</td></tr><tr><td>Protocol specific parameters</td><td>Additional parameters used by the protocol</td><td>False</td></tr></tbody></table>
92
- <p>Example Usage:</p>
93
- <pre><code class="language-ruby">INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil
94
- MAP_TARGET DATA
95
- # Rather than defining the LENGTH protocol on the INTERFACE line we define it here
96
- PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11
97
- INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
98
- MAP_TARGET DATA
99
- PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets
100
- </code></pre>
101
- <h3 id="option">OPTION</h3>
88
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>Whether to apply the protocol on incoming data, outgoing data, or both<br><br>Valid Values: <span class="values">READ, WRITE, READ_WRITE</span></td><td>True</td></tr><tr><td>Protocol Filename or Classname</td><td>Ruby or Python filename or class name which implements the protocol</td><td>True</td></tr><tr><td>Protocol specific parameters</td><td>Additional parameters used by the protocol</td><td>False</td></tr></tbody></table>
89
+ <p>Ruby Example:</p>
90
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
91
+ <p>Python Example:</p>
92
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
93
+ <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>
102
94
  <p><strong>Set a parameter on an interface</strong></p>
103
95
  <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>
104
96
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).</td><td>True</td></tr><tr><td>Parameters</td><td>Parameters to pass to the option</td><td>False</td></tr></tbody></table>
105
97
  <p>Example Usage:</p>
106
- <pre><code class="language-ruby">INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil
107
- OPTION FLOW_CONTROL RTSCTS
108
- OPTION DATA_BITS 8
109
- ROUTER SERIAL_ROUTER tcpip_server_interface.rb 2950 2950 10.0 nil BURST
110
- ROUTE SERIAL_INT
111
- OPTION LISTEN_ADDRESS 127.0.0.1
112
- </code></pre>
113
- <h3 id="secret">SECRET</h3>
98
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
99
+ <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>
114
100
  <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
115
101
  <p>Defines a secret for this interface and optionally assigns its value to an option</p>
116
102
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Option Name</td><td>Interface option to pass the secret value</td><td>False</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
117
103
  <p>Example Usage:</p>
118
- <pre><code class="language-ruby">SECRET ENV USERNAME ENV_USERNAME USERNAME
119
- SECRET FILE KEY &quot;/tmp/DATA/cert&quot; KEY
120
- </code></pre>
121
- <h3 id="env">ENV</h3>
104
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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)">&quot;/tmp/DATA/cert&quot;</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
105
+ <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>
122
106
  <p></p><div class="right">(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
123
107
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
124
108
  <p>Example Usage:</p>
125
- <pre><code class="language-ruby">ENV COMPANY OpenC3
126
- </code></pre>
127
- <h3 id="work_dir">WORK_DIR</h3>
109
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
110
+ <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>
128
111
  <p></p><div class="right">(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
129
112
  <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>
130
113
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
131
114
  <p>Example Usage:</p>
132
- <pre><code class="language-ruby">WORK_DIR &#x27;/openc3/lib/openc3/microservices&#x27;
133
- </code></pre>
134
- <h3 id="port">PORT</h3>
115
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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)">&#x27;/openc3/lib/openc3/microservices&#x27;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
116
+ <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>
135
117
  <p></p><div class="right">(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
136
118
  <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
137
119
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
138
120
  <p>Example Usage:</p>
139
- <pre><code class="language-ruby">PORT 7272
140
- </code></pre>
141
- <h3 id="cmd">CMD</h3>
121
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
122
+ <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>
142
123
  <p></p><div class="right">(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
143
124
  <p>Command line to execute to run the microservice.</p>
144
125
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
145
- <p>Example Usage:</p>
146
- <pre><code class="language-ruby">CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
147
- </code></pre>
148
- <h3 id="container">CONTAINER</h3>
126
+ <p>Ruby Example:</p>
127
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
128
+ <p>Python Example:</p>
129
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
130
+ <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>
149
131
  <p></p><div class="right">(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
150
132
  <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
151
133
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
152
- <h3 id="route_prefix">ROUTE_PREFIX</h3>
134
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="route_prefix">ROUTE_PREFIX<a href="#route_prefix" class="hash-link" aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX">​</a></h3>
153
135
  <p></p><div class="right">(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
154
136
  <p>Prefix of route to the microservice to expose externally with Traefik</p>
155
137
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
156
138
  <p>Example Usage:</p>
157
- <pre><code class="language-ruby">ROUTE_PREFIX /interface
158
- </code></pre>
159
- <h2 id="router-1">ROUTER</h2>
139
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
140
+ <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>
160
141
  <p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
161
142
  <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>
162
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the router</td><td>True</td></tr><tr><td>Filename</td><td>Ruby file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb</span></td><td>True</td></tr></tbody></table>
143
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the router</td><td>True</td></tr><tr><td>Filename</td><td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span></td><td>True</td></tr></tbody></table>
163
144
  <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
164
- <h2 id="target-1">TARGET</h2>
145
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="target-1">TARGET<a href="#target-1" class="hash-link" aria-label="Direct link to TARGET" title="Direct link to TARGET">​</a></h2>
165
146
  <p><strong>Defines a new target</strong></p>
166
147
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Folder Name</td><td>The target folder</td><td>True</td></tr><tr><td>Name</td><td>The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder.</td><td>True</td></tr></tbody></table>
167
148
  <p>Example Usage:</p>
168
- <pre><code class="language-ruby">TARGET INST INST
169
- </code></pre>
170
- <h2 id="target-modifiers">TARGET Modifiers</h2>
149
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
150
+ <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>
171
151
  <p>The following keywords must follow a TARGET keyword.</p>
172
- <h3 id="cmd_buffer_depth">CMD_BUFFER_DEPTH</h3>
152
+ <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>
173
153
  <p></p><div class="right">(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
174
154
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 5)</td><td>True</td></tr></tbody></table>
175
- <h3 id="cmd_log_cycle_time">CMD_LOG_CYCLE_TIME</h3>
155
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_cycle_time">CMD_LOG_CYCLE_TIME<a href="#cmd_log_cycle_time" class="hash-link" aria-label="Direct link to CMD_LOG_CYCLE_TIME" title="Direct link to CMD_LOG_CYCLE_TIME">​</a></h3>
176
156
  <p><strong>Command binary logs can be cycled on a time interval.</strong></p>
177
157
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
178
- <h3 id="cmd_log_cycle_size">CMD_LOG_CYCLE_SIZE</h3>
158
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_cycle_size">CMD_LOG_CYCLE_SIZE<a href="#cmd_log_cycle_size" class="hash-link" aria-label="Direct link to CMD_LOG_CYCLE_SIZE" title="Direct link to CMD_LOG_CYCLE_SIZE">​</a></h3>
179
159
  <p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
180
160
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
181
- <h3 id="cmd_log_retain_time">CMD_LOG_RETAIN_TIME</h3>
161
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_retain_time">CMD_LOG_RETAIN_TIME<a href="#cmd_log_retain_time" class="hash-link" aria-label="Direct link to CMD_LOG_RETAIN_TIME" title="Direct link to CMD_LOG_RETAIN_TIME">​</a></h3>
182
162
  <p><strong>How long to keep raw command logs in seconds.</strong></p>
183
163
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
184
- <h3 id="cmd_decom_log_cycle_time">CMD_DECOM_LOG_CYCLE_TIME</h3>
164
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_cycle_time">CMD_DECOM_LOG_CYCLE_TIME<a href="#cmd_decom_log_cycle_time" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_CYCLE_TIME" title="Direct link to CMD_DECOM_LOG_CYCLE_TIME">​</a></h3>
185
165
  <p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
186
166
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
187
- <h3 id="cmd_decom_log_cycle_size">CMD_DECOM_LOG_CYCLE_SIZE</h3>
167
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_cycle_size">CMD_DECOM_LOG_CYCLE_SIZE<a href="#cmd_decom_log_cycle_size" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_CYCLE_SIZE" title="Direct link to CMD_DECOM_LOG_CYCLE_SIZE">​</a></h3>
188
168
  <p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
189
169
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
190
- <h3 id="cmd_decom_log_retain_time">CMD_DECOM_LOG_RETAIN_TIME</h3>
170
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_retain_time">CMD_DECOM_LOG_RETAIN_TIME<a href="#cmd_decom_log_retain_time" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_RETAIN_TIME" title="Direct link to CMD_DECOM_LOG_RETAIN_TIME">​</a></h3>
191
171
  <p><strong>How long to keep decom command logs in seconds.</strong></p>
192
172
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
193
- <h3 id="tlm_buffer_depth">TLM_BUFFER_DEPTH</h3>
173
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_buffer_depth">TLM_BUFFER_DEPTH<a href="#tlm_buffer_depth" class="hash-link" aria-label="Direct link to TLM_BUFFER_DEPTH" title="Direct link to TLM_BUFFER_DEPTH">​</a></h3>
194
174
  <p></p><div class="right">(Since 5.2.0)</div><strong>Number of telemetry packets to buffer to ensure logged in order</strong><p></p>
195
175
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 60)</td><td>True</td></tr></tbody></table>
196
- <h3 id="tlm_log_cycle_time">TLM_LOG_CYCLE_TIME</h3>
176
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_cycle_time">TLM_LOG_CYCLE_TIME<a href="#tlm_log_cycle_time" class="hash-link" aria-label="Direct link to TLM_LOG_CYCLE_TIME" title="Direct link to TLM_LOG_CYCLE_TIME">​</a></h3>
197
177
  <p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
198
178
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
199
- <h3 id="tlm_log_cycle_size">TLM_LOG_CYCLE_SIZE</h3>
179
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_cycle_size">TLM_LOG_CYCLE_SIZE<a href="#tlm_log_cycle_size" class="hash-link" aria-label="Direct link to TLM_LOG_CYCLE_SIZE" title="Direct link to TLM_LOG_CYCLE_SIZE">​</a></h3>
200
180
  <p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
201
181
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
202
- <h3 id="tlm_log_retain_time">TLM_LOG_RETAIN_TIME</h3>
182
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_retain_time">TLM_LOG_RETAIN_TIME<a href="#tlm_log_retain_time" class="hash-link" aria-label="Direct link to TLM_LOG_RETAIN_TIME" title="Direct link to TLM_LOG_RETAIN_TIME">​</a></h3>
203
183
  <p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
204
184
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
205
- <h3 id="tlm_decom_log_cycle_time">TLM_DECOM_LOG_CYCLE_TIME</h3>
185
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_cycle_time">TLM_DECOM_LOG_CYCLE_TIME<a href="#tlm_decom_log_cycle_time" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_CYCLE_TIME" title="Direct link to TLM_DECOM_LOG_CYCLE_TIME">​</a></h3>
206
186
  <p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
207
187
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
208
- <h3 id="tlm_decom_log_cycle_size">TLM_DECOM_LOG_CYCLE_SIZE</h3>
188
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_cycle_size">TLM_DECOM_LOG_CYCLE_SIZE<a href="#tlm_decom_log_cycle_size" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_CYCLE_SIZE" title="Direct link to TLM_DECOM_LOG_CYCLE_SIZE">​</a></h3>
209
189
  <p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
210
190
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
211
- <h3 id="tlm_decom_log_retain_time">TLM_DECOM_LOG_RETAIN_TIME</h3>
191
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_retain_time">TLM_DECOM_LOG_RETAIN_TIME<a href="#tlm_decom_log_retain_time" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_RETAIN_TIME" title="Direct link to TLM_DECOM_LOG_RETAIN_TIME">​</a></h3>
212
192
  <p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
213
193
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
214
- <h3 id="reduced_minute_log_retain_time">REDUCED_MINUTE_LOG_RETAIN_TIME</h3>
194
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_minute_log_retain_time">REDUCED_MINUTE_LOG_RETAIN_TIME<a href="#reduced_minute_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME" title="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME">​</a></h3>
215
195
  <p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
216
196
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
217
- <h3 id="reduced_hour_log_retain_time">REDUCED_HOUR_LOG_RETAIN_TIME</h3>
197
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_hour_log_retain_time">REDUCED_HOUR_LOG_RETAIN_TIME<a href="#reduced_hour_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME" title="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME">​</a></h3>
218
198
  <p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
219
199
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
220
- <h3 id="reduced_day_log_retain_time">REDUCED_DAY_LOG_RETAIN_TIME</h3>
200
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_day_log_retain_time">REDUCED_DAY_LOG_RETAIN_TIME<a href="#reduced_day_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_DAY_LOG_RETAIN_TIME" title="Direct link to REDUCED_DAY_LOG_RETAIN_TIME">​</a></h3>
221
201
  <p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
222
202
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced day telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
223
- <h3 id="log_retain_time">LOG_RETAIN_TIME</h3>
203
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_retain_time">LOG_RETAIN_TIME<a href="#log_retain_time" class="hash-link" aria-label="Direct link to LOG_RETAIN_TIME" title="Direct link to LOG_RETAIN_TIME">​</a></h3>
224
204
  <p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
225
205
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all regular telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
226
- <h3 id="reduced_log_retain_time">REDUCED_LOG_RETAIN_TIME</h3>
206
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_log_retain_time">REDUCED_LOG_RETAIN_TIME<a href="#reduced_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_LOG_RETAIN_TIME" title="Direct link to REDUCED_LOG_RETAIN_TIME">​</a></h3>
227
207
  <p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
228
208
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all reduced telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
229
- <h3 id="cleanup_poll_time">CLEANUP_POLL_TIME</h3>
209
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cleanup_poll_time">CLEANUP_POLL_TIME<a href="#cleanup_poll_time" class="hash-link" aria-label="Direct link to CLEANUP_POLL_TIME" title="Direct link to CLEANUP_POLL_TIME">​</a></h3>
230
210
  <p><strong>Period at which to run the cleanup process.</strong></p>
231
211
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)</td><td>True</td></tr></tbody></table>
232
- <h3 id="reducer_disable">REDUCER_DISABLE</h3>
212
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reducer_disable">REDUCER_DISABLE<a href="#reducer_disable" class="hash-link" aria-label="Direct link to REDUCER_DISABLE" title="Direct link to REDUCER_DISABLE">​</a></h3>
233
213
  <p><strong>Disables the data reduction microservice for the target</strong></p>
234
- <h3 id="reducer_max_cpu_utilization">REDUCER_MAX_CPU_UTILIZATION</h3>
214
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reducer_max_cpu_utilization">REDUCER_MAX_CPU_UTILIZATION<a href="#reducer_max_cpu_utilization" class="hash-link" aria-label="Direct link to REDUCER_MAX_CPU_UTILIZATION" title="Direct link to REDUCER_MAX_CPU_UTILIZATION">​</a></h3>
235
215
  <p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
236
216
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Percentage</td><td>0 to 100 percent (default = 30)</td><td>True</td></tr></tbody></table>
237
- <h3 id="target_microservice">TARGET_MICROSERVICE</h3>
217
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="target_microservice">TARGET_MICROSERVICE<a href="#target_microservice" class="hash-link" aria-label="Direct link to TARGET_MICROSERVICE" title="Direct link to TARGET_MICROSERVICE">​</a></h3>
238
218
  <p></p><div class="right">(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
239
219
  <p>Can be used to give more resources to processing that is falling behind. If defined multiple times for the same type, will create multiple processes. Each process can be given specific packets to process with the PACKET keyword.</p>
240
220
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP</td><td>True</td></tr></tbody></table>
241
- <h3 id="packet">PACKET</h3>
221
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="packet">PACKET<a href="#packet" class="hash-link" aria-label="Direct link to PACKET" title="Direct link to PACKET">​</a></h3>
242
222
  <p></p><div class="right">(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
243
223
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Packet Name</td><td>The packet name. Does not apply to REDUCER or CLEANUP target microservice types.</td><td>True</td></tr></tbody></table>
244
- <h3 id="disable_erb">DISABLE_ERB</h3>
224
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb">DISABLE_ERB<a href="#disable_erb" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
245
225
  <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
246
226
  <p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
247
227
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
248
- <h2 id="microservice-1">MICROSERVICE</h2>
228
+ <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>
249
229
  <p><strong>Defines a new microservice</strong></p>
250
230
  <p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
251
231
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Microservice Folder Name</td><td>The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName</td><td>True</td></tr><tr><td>Microservice Name</td><td>The specific name of this instance of the microservice in the OpenC3 system</td><td>True</td></tr></tbody></table>
252
232
  <p>Example Usage:</p>
253
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
254
- </code></pre>
255
- <h2 id="microservice-modifiers">MICROSERVICE Modifiers</h2>
233
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
234
+ <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>
256
235
  <p>The following keywords must follow a MICROSERVICE keyword.</p>
257
- <h3 id="env-1">ENV</h3>
236
+ <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>
258
237
  <p><strong>Sets an environment variable in the microservice.</strong></p>
259
238
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
260
239
  <p>Example Usage:</p>
261
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
262
- ENV COMPANY OpenC3
263
- </code></pre>
264
- <h3 id="work_dir-1">WORK_DIR</h3>
240
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
241
+ <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>
265
242
  <p><strong>Set the working directory</strong></p>
266
243
  <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>
267
244
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
268
245
  <p>Example Usage:</p>
269
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
270
- WORK_DIR .
271
- </code></pre>
272
- <h3 id="port-1">PORT</h3>
246
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
247
+ <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>
273
248
  <p></p><div class="right">(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
274
249
  <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
275
250
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
276
251
  <p>Example Usage:</p>
277
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
278
- PORT 7272
279
- </code></pre>
280
- <h3 id="topic">TOPIC</h3>
252
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
253
+ <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>
281
254
  <p><strong>Associate a Redis topic</strong></p>
282
255
  <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>
283
256
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Topic Name</td><td>Redis Topic to associate with the microservice</td><td>True</td></tr></tbody></table>
284
257
  <p>Example Usage:</p>
285
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
286
- # Manually assigning topics is an advanced topic and requires
287
- # intimate knowledge of the internal COSMOS data structures.
288
- TOPIC DEFAULT__openc3_log_messages
289
- TOPIC DEFAULT__TELEMETRY__EXAMPLE__STATUS
290
- </code></pre>
291
- <h3 id="target_name">TARGET_NAME</h3>
258
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
259
+ <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>
292
260
  <p><strong>Associate a OpenC3 target</strong></p>
293
261
  <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>
294
262
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>OpenC3 target to associate with the microservice</td><td>True</td></tr></tbody></table>
295
263
  <p>Example Usage:</p>
296
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
297
- TARGET_NAME EXAMPLE
298
- </code></pre>
299
- <h3 id="cmd-1">CMD</h3>
264
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
265
+ <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>
300
266
  <p><strong>Command line to execute to run the microservice.</strong></p>
301
267
  <p>Command line to execute to run the microservice.</p>
302
268
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
303
- <p>Example Usage:</p>
304
- <pre><code class="language-ruby">MICROSERVICE EXAMPLE openc3-example
305
- CMD ruby example_target.rb
306
- </code></pre>
307
- <h3 id="option-1">OPTION</h3>
269
+ <p>Ruby Example:</p>
270
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
271
+ <p>Python Example:</p>
272
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
273
+ <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>
308
274
  <p><strong>Pass an option to the microservice</strong></p>
309
275
  <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>
310
276
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Option Name</td><td>Name of the option</td><td>True</td></tr><tr><td>Option Value(s)</td><td>One or more values to associate with the option</td><td>True</td></tr></tbody></table>
311
- <h3 id="container-1">CONTAINER</h3>
277
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="container-1">CONTAINER<a href="#container-1" class="hash-link" aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER">​</a></h3>
312
278
  <p><strong>Docker Container</strong></p>
313
279
  <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
314
280
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
315
- <h3 id="secret-1">SECRET</h3>
281
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="secret-1">SECRET<a href="#secret-1" class="hash-link" aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
316
282
  <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
317
283
  <p>Defines a secret for this microservice</p>
318
284
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
319
285
  <p>Example Usage:</p>
320
- <pre><code class="language-ruby">SECRET ENV USERNAME ENV_USERNAME
321
- SECRET FILE KEY &quot;/tmp/DATA/cert&quot;
322
- </code></pre>
323
- <h3 id="route_prefix-1">ROUTE_PREFIX</h3>
286
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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)">&quot;/tmp/DATA/cert&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
287
+ <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>
324
288
  <p></p><div class="right">(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
325
289
  <p>Prefix of route to the microservice to expose externally with Traefik</p>
326
290
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
327
291
  <p>Example Usage:</p>
328
- <pre><code class="language-ruby">MICROSERVICE CFDP CFDP
329
- ROUTE_PREFIX /cfdp
330
- </code></pre>
331
- <h3 id="disable_erb-1">DISABLE_ERB</h3>
292
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
293
+ <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>
332
294
  <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
333
295
  <p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
334
296
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
335
- <h2 id="tool-1">TOOL</h2>
297
+ <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>
336
298
  <p><strong>Define a tool</strong></p>
337
299
  <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>
338
300
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Tool Folder Name</td><td>The exact name of the tool folder in the plugin. ie. tools/ToolFolderName</td><td>True</td></tr><tr><td>Tool Name</td><td>Name of the tool that is displayed in the OpenC3 Navigation menu</td><td>True</td></tr></tbody></table>
339
301
  <p>Example Usage:</p>
340
- <pre><code class="language-ruby">TOOL DEMO Demo
341
- </code></pre>
342
- <h2 id="tool-modifiers">TOOL Modifiers</h2>
302
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
303
+ <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>
343
304
  <p>The following keywords must follow a TOOL keyword.</p>
344
- <h3 id="url">URL</h3>
305
+ <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>
345
306
  <p><strong>Url used to access the tool</strong></p>
346
307
  <p>The relative url used to access the tool. Defaults to &quot;/tools/ToolFolderName&quot;.</p>
347
308
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.</td><td>True</td></tr></tbody></table>
348
- <h3 id="inline_url">INLINE_URL</h3>
309
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="inline_url">INLINE_URL<a href="#inline_url" class="hash-link" aria-label="Direct link to INLINE_URL" title="Direct link to INLINE_URL">​</a></h3>
349
310
  <p><strong>Internal url to load a tool</strong></p>
350
311
  <p>The url of the javascript file used to load the tool into single-SPA. Defaults to &quot;js/app.js&quot;.</p>
351
312
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename.</td><td>True</td></tr></tbody></table>
352
- <h3 id="window">WINDOW</h3>
313
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="window">WINDOW<a href="#window" class="hash-link" aria-label="Direct link to WINDOW" title="Direct link to WINDOW">​</a></h3>
353
314
  <p><strong>How to display the tool when navigated to</strong></p>
354
315
  <p>The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within OpenC3. NEW opens the tool in a new TAB.</p>
355
316
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Window Mode</td><td>Tool display mode<br><br>Valid Values: <span class="values">INLINE, IFRAME, NEW</span></td><td>True</td></tr></tbody></table>
356
- <h3 id="icon">ICON</h3>
317
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="icon">ICON<a href="#icon" class="hash-link" aria-label="Direct link to ICON" title="Direct link to ICON">​</a></h3>
357
318
  <p><strong>Set tool icon</strong></p>
358
319
  <p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
359
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon Name</td><td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href="https://materialdesignicons.com/">https://materialdesignicons.com/</a>), and Astro.</td><td>True</td></tr></tbody></table>
360
- <h3 id="category">CATEGORY</h3>
320
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon Name</td><td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href="https://materialdesignicons.com/" target="_blank" rel="noopener noreferrer">https://materialdesignicons.com/</a>), and Astro.</td><td>True</td></tr></tbody></table>
321
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="category">CATEGORY<a href="#category" class="hash-link" aria-label="Direct link to CATEGORY" title="Direct link to CATEGORY">​</a></h3>
361
322
  <p><strong>Category for the tool</strong></p>
362
323
  <p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
363
324
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Category Name</td><td>Category to associate the tool with</td><td>True</td></tr></tbody></table>
364
- <h3 id="shown">SHOWN</h3>
325
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="shown">SHOWN<a href="#shown" class="hash-link" aria-label="Direct link to SHOWN" title="Direct link to SHOWN">​</a></h3>
365
326
  <p><strong>Show the tool or not</strong></p>
366
327
  <p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
367
328
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Shown</td><td>Whether or not the tool is shown. TRUE or FALSE<br><br>Valid Values: <span class="values">true, false</span></td><td>True</td></tr></tbody></table>
368
- <h3 id="position">POSITION</h3>
329
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="position">POSITION<a href="#position" class="hash-link" aria-label="Direct link to POSITION" title="Direct link to POSITION">​</a></h3>
369
330
  <p></p><div class="right">(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
370
331
  <p>Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed.</p>
371
332
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Position</td><td>Numerical position</td><td>True</td></tr></tbody></table>
372
- <h3 id="disable_erb-2">DISABLE_ERB</h3>
333
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb-2">DISABLE_ERB<a href="#disable_erb-2" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
373
334
  <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
374
335
  <p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
375
336
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
376
- <h2 id="widget">WIDGET</h2>
337
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="widget">WIDGET<a href="#widget" class="hash-link" aria-label="Direct link to WIDGET" title="Direct link to WIDGET">​</a></h2>
377
338
  <p><strong>Define a custom widget</strong></p>
378
339
  <p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
379
340
  <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Name</td><td>The name of the widget wil be used to build a path to the widget implementation. For example, <code>WIDGET HELLOWORLD</code> will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide for more details.</td><td>True</td></tr></tbody></table>
380
341
  <p>Example Usage:</p>
381
- <pre><code class="language-ruby">WIDGET HELLOWORLD
382
- </code></pre>
383
- <h2 id="widget-modifiers">WIDGET Modifiers</h2>
342
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
343
+ <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>
384
344
  <p>The following keywords must follow a WIDGET keyword.</p>
385
- <h3 id="disable_erb-3">DISABLE_ERB</h3>
345
+ <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>
386
346
  <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
387
347
  <p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
388
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="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"></path></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 class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#introduction">Introduction</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#concepts">Concepts</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#target">Target</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#interface">Interface</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#router">Router</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tool">Tool</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#microservice">Microservice</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#plugin-directory-structure">Plugin Directory Structure</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#plugintxt-configuration-file">plugin.txt Configuration File</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#variable">VARIABLE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#needs_dependencies">NEEDS_DEPENDENCIES</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#interface-1">INTERFACE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#interface-modifiers">INTERFACE Modifiers</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#map_target">MAP_TARGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#map_cmd_target">MAP_CMD_TARGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#map_tlm_target">MAP_TLM_TARGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#dont_connect">DONT_CONNECT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#dont_reconnect">DONT_RECONNECT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reconnect_delay">RECONNECT_DELAY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#disable_disconnect">DISABLE_DISCONNECT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#log_raw">LOG_RAW</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#log_stream">LOG_STREAM</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#protocol">PROTOCOL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#option">OPTION</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#secret">SECRET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#env">ENV</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#work_dir">WORK_DIR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#port">PORT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd">CMD</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#container">CONTAINER</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#route_prefix">ROUTE_PREFIX</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#router-1">ROUTER</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#target-1">TARGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#target-modifiers">TARGET Modifiers</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_buffer_depth">CMD_BUFFER_DEPTH</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_log_cycle_time">CMD_LOG_CYCLE_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_log_cycle_size">CMD_LOG_CYCLE_SIZE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_log_retain_time">CMD_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_decom_log_cycle_time">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_decom_log_cycle_size">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd_decom_log_retain_time">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_buffer_depth">TLM_BUFFER_DEPTH</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_log_cycle_time">TLM_LOG_CYCLE_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_log_cycle_size">TLM_LOG_CYCLE_SIZE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_log_retain_time">TLM_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_decom_log_cycle_time">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_decom_log_cycle_size">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tlm_decom_log_retain_time">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reduced_minute_log_retain_time">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reduced_hour_log_retain_time">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reduced_day_log_retain_time">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#log_retain_time">LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reduced_log_retain_time">REDUCED_LOG_RETAIN_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cleanup_poll_time">CLEANUP_POLL_TIME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reducer_disable">REDUCER_DISABLE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#reducer_max_cpu_utilization">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#target_microservice">TARGET_MICROSERVICE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#packet">PACKET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#disable_erb">DISABLE_ERB</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#microservice-1">MICROSERVICE</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#microservice-modifiers">MICROSERVICE Modifiers</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#env-1">ENV</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#work_dir-1">WORK_DIR</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#port-1">PORT</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#topic">TOPIC</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#target_name">TARGET_NAME</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#cmd-1">CMD</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#option-1">OPTION</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#container-1">CONTAINER</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#secret-1">SECRET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#route_prefix-1">ROUTE_PREFIX</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#disable_erb-1">DISABLE_ERB</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tool-1">TOOL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#tool-modifiers">TOOL Modifiers</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#url">URL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#inline_url">INLINE_URL</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#window">WINDOW</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#icon">ICON</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#category">CATEGORY</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#shown">SHOWN</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#position">POSITION</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#disable_erb-2">DISABLE_ERB</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#widget">WIDGET</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#widget-modifiers">WIDGET Modifiers</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/configuration/plugins#disable_erb-3">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
348
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="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"></path></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><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
389
349
  </body>
390
350
  </html>