openc3-cosmos-tool-docs 5.12.0 → 5.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (624) hide show
  1. checksums.yaml +4 -4
  2. data/plugin.txt +3 -3
  3. data/tools/staticdocs/404.html +13 -0
  4. data/tools/staticdocs/assets/css/styles.6e885bef.css +1 -0
  5. data/tools/staticdocs/assets/js/019369f3.d8613c30.js +1 -0
  6. data/tools/staticdocs/assets/js/058ffc22.acfac831.js +1 -0
  7. data/tools/staticdocs/assets/js/0686a885.4e302d8a.js +1 -0
  8. data/tools/staticdocs/assets/js/07876b9c.990c8af0.js +1 -0
  9. data/tools/staticdocs/assets/js/078dbab0.d34d0a8f.js +1 -0
  10. data/tools/staticdocs/assets/js/0f5d161c.d985bc97.js +1 -0
  11. data/tools/staticdocs/assets/js/0ff569c9.e271df4e.js +1 -0
  12. data/tools/staticdocs/assets/js/103cc3be.4cf4eeb0.js +1 -0
  13. data/tools/staticdocs/assets/js/12.ef103c80.js +1 -0
  14. data/tools/staticdocs/assets/js/13196248.51e9b91e.js +1 -0
  15. data/tools/staticdocs/assets/js/13c1b4e4.82c72cb7.js +1 -0
  16. data/tools/staticdocs/assets/js/1b2b4b61.b662e271.js +1 -0
  17. data/tools/staticdocs/assets/js/2047b354.fd40457e.js +1 -0
  18. data/tools/staticdocs/assets/js/22b3ac48.10ffd4c3.js +1 -0
  19. data/tools/staticdocs/assets/js/2624.ae6ba6f0.js +1 -0
  20. data/tools/staticdocs/assets/js/26b8abb2.a77dc1e7.js +1 -0
  21. data/tools/staticdocs/assets/js/3dd7ef3b.e063c83a.js +1 -0
  22. data/tools/staticdocs/assets/js/3df159b4.7047e215.js +1 -0
  23. data/tools/staticdocs/assets/js/40365d27.cfe2d836.js +1 -0
  24. data/tools/staticdocs/assets/js/411898ad.fb3b44cb.js +1 -0
  25. data/tools/staticdocs/assets/js/42170351.cee0ce87.js +1 -0
  26. data/tools/staticdocs/assets/js/43652efd.a68af7c2.js +1 -0
  27. data/tools/staticdocs/assets/js/4657.9492019f.js +2 -0
  28. data/tools/staticdocs/assets/js/53ca7c5b.5ba66d69.js +1 -0
  29. data/tools/staticdocs/assets/js/54d0d530.ae86bb53.js +1 -0
  30. data/tools/staticdocs/assets/js/55cdbca5.9562da85.js +1 -0
  31. data/tools/staticdocs/assets/js/5bc719f6.3f10a4f9.js +1 -0
  32. data/tools/staticdocs/assets/js/5c6ce5ec.3cb1b75a.js +1 -0
  33. data/tools/staticdocs/assets/js/5e3ed378.98a98907.js +1 -0
  34. data/tools/staticdocs/assets/js/5fe211ef.943a1325.js +1 -0
  35. data/tools/staticdocs/assets/js/64630c4f.d3aaa17e.js +1 -0
  36. data/tools/staticdocs/assets/js/6831b732.677fead8.js +1 -0
  37. data/tools/staticdocs/assets/js/696b4199.68411c90.js +1 -0
  38. data/tools/staticdocs/assets/js/6b210247.f17d074a.js +1 -0
  39. data/tools/staticdocs/assets/js/6b65133b.1691ed32.js +1 -0
  40. data/tools/staticdocs/assets/js/6f92e431.0e99b0f7.js +1 -0
  41. data/tools/staticdocs/assets/js/7158.db39a041.js +1 -0
  42. data/tools/staticdocs/assets/js/72c6d8a8.895d48ed.js +1 -0
  43. data/tools/staticdocs/assets/js/75373ac0.f2ff00fb.js +1 -0
  44. data/tools/staticdocs/assets/js/75e64983.a5199202.js +1 -0
  45. data/tools/staticdocs/assets/js/867640d5.52676c0c.js +1 -0
  46. data/tools/staticdocs/assets/js/89e76475.da0a4de8.js +1 -0
  47. data/tools/staticdocs/assets/js/8f7843ee.5069508d.js +1 -0
  48. data/tools/staticdocs/assets/js/9424f0b3.d0685f0f.js +1 -0
  49. data/tools/staticdocs/assets/js/97535711.7354a61a.js +1 -0
  50. data/tools/staticdocs/assets/js/99581c43.d6c28a4e.js +1 -0
  51. data/tools/staticdocs/assets/js/99b59eea.56ab3bff.js +1 -0
  52. data/tools/staticdocs/assets/js/9d6e81d0.9a3ba2db.js +1 -0
  53. data/tools/staticdocs/assets/js/9fb6059a.709498de.js +1 -0
  54. data/tools/staticdocs/assets/js/a507c363.b04cc959.js +1 -0
  55. data/tools/staticdocs/assets/js/a677c089.759b7b09.js +1 -0
  56. data/tools/staticdocs/assets/js/a9987364.e1bf97fd.js +1 -0
  57. data/tools/staticdocs/assets/js/aa6b6c1b.eb0299eb.js +1 -0
  58. data/tools/staticdocs/assets/js/b4596165.d2ef4105.js +1 -0
  59. data/tools/staticdocs/assets/js/b6d70f94.67e3cf1e.js +1 -0
  60. data/tools/staticdocs/assets/js/b9f60ba6.4f87cb90.js +1 -0
  61. data/tools/staticdocs/assets/js/bd0034eb.caedd00a.js +1 -0
  62. data/tools/staticdocs/assets/js/c24eae19.541e6a95.js +1 -0
  63. data/tools/staticdocs/assets/js/cb8c3f08.9ca026be.js +1 -0
  64. data/tools/staticdocs/assets/js/cd879be4.4b9bf792.js +1 -0
  65. data/tools/staticdocs/assets/js/d1b923aa.2c753a51.js +1 -0
  66. data/tools/staticdocs/assets/js/d1bfc316.f860e15e.js +1 -0
  67. data/tools/staticdocs/assets/js/d24bf9b6.a8d698fc.js +1 -0
  68. data/tools/staticdocs/assets/js/d57a4b5d.743b976b.js +1 -0
  69. data/tools/staticdocs/assets/js/d5d77c37.c1e1579f.js +1 -0
  70. data/tools/staticdocs/assets/js/d8ca4191.abd56e6c.js +1 -0
  71. data/tools/staticdocs/assets/js/d9b92eba.cd5125b1.js +1 -0
  72. data/tools/staticdocs/assets/js/db8fa1d0.c1a3930b.js +1 -0
  73. data/tools/staticdocs/assets/js/dc5f7beb.87e69867.js +1 -0
  74. data/tools/staticdocs/assets/js/e501b0d1.64985b23.js +1 -0
  75. data/tools/staticdocs/assets/js/ebec1ccb.15788749.js +1 -0
  76. data/tools/staticdocs/assets/js/f15615f1.0d1e925a.js +1 -0
  77. data/tools/staticdocs/assets/js/fd886806.5a283ff8.js +1 -0
  78. data/tools/staticdocs/assets/js/main.1b3209ca.js +2 -0
  79. data/tools/{docs/assets/js/main.b5a535c2.js.LICENSE.txt → staticdocs/assets/js/main.1b3209ca.js.LICENSE.txt} +24 -23
  80. data/tools/staticdocs/assets/js/runtime~main.6ca622b3.js +1 -0
  81. data/tools/staticdocs/docs/configuration/command.html +252 -0
  82. data/tools/staticdocs/docs/configuration/format.html +51 -0
  83. data/tools/staticdocs/docs/configuration/interfaces.html +72 -0
  84. data/tools/staticdocs/docs/configuration/plugins.html +339 -0
  85. data/tools/staticdocs/docs/configuration/protocols.html +118 -0
  86. data/tools/staticdocs/docs/configuration/ssl-tls.html +97 -0
  87. data/tools/staticdocs/docs/configuration/table.html +178 -0
  88. data/tools/staticdocs/docs/configuration/target.html +60 -0
  89. data/tools/staticdocs/docs/configuration/telemetry-screens.html +526 -0
  90. data/tools/staticdocs/docs/configuration/telemetry.html +198 -0
  91. data/tools/staticdocs/docs/configuration.html +13 -0
  92. data/tools/staticdocs/docs/development/curl.html +30 -0
  93. data/tools/staticdocs/docs/development/developing.html +111 -0
  94. data/tools/staticdocs/docs/development/host-install.html +38 -0
  95. data/tools/staticdocs/docs/development/json-api.html +59 -0
  96. data/tools/staticdocs/docs/development/log-structure.html +38 -0
  97. data/tools/staticdocs/docs/development/roadmap.html +15 -0
  98. data/tools/staticdocs/docs/development/streaming-api.html +37 -0
  99. data/tools/staticdocs/docs/development/testing.html +60 -0
  100. data/tools/staticdocs/docs/development.html +13 -0
  101. data/tools/staticdocs/docs/getting-started/gettingstarted.html +128 -0
  102. data/tools/staticdocs/docs/getting-started/installation.html +66 -0
  103. data/tools/staticdocs/docs/getting-started/key_concepts.html +45 -0
  104. data/tools/staticdocs/docs/getting-started/podman.html +95 -0
  105. data/tools/staticdocs/docs/getting-started/requirements.html +84 -0
  106. data/tools/staticdocs/docs/getting-started/upgrading.html +47 -0
  107. data/tools/staticdocs/docs/getting-started.html +13 -0
  108. data/tools/staticdocs/docs/guides/bridges.html +63 -0
  109. data/tools/staticdocs/docs/guides/cfs.html +115 -0
  110. data/tools/staticdocs/docs/guides/custom-widgets.html +30 -0
  111. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +31 -0
  112. data/tools/staticdocs/docs/guides/local-mode.html +37 -0
  113. data/tools/staticdocs/docs/guides/logging.html +31 -0
  114. data/tools/staticdocs/docs/guides/monitoring.html +52 -0
  115. data/tools/staticdocs/docs/guides/performance.html +59 -0
  116. data/tools/staticdocs/docs/guides/raspberrypi.html +81 -0
  117. data/tools/staticdocs/docs/guides/script-writing.html +260 -0
  118. data/tools/staticdocs/docs/guides/scripting-api.html +1073 -0
  119. data/tools/staticdocs/docs/guides.html +13 -0
  120. data/tools/staticdocs/docs/meta/contributing.html +52 -0
  121. data/tools/staticdocs/docs/meta/philosophy.html +39 -0
  122. data/tools/staticdocs/docs/meta/xtce.html +110 -0
  123. data/tools/staticdocs/docs/meta.html +13 -0
  124. data/tools/staticdocs/docs/privacy.html +68 -0
  125. data/tools/staticdocs/docs/tools/autonomic.html +28 -0
  126. data/tools/staticdocs/docs/tools/bucket-explorer.html +23 -0
  127. data/tools/staticdocs/docs/tools/calendar.html +47 -0
  128. data/tools/staticdocs/docs/tools/cmd-sender.html +39 -0
  129. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +45 -0
  130. data/tools/staticdocs/docs/tools/data-extractor.html +73 -0
  131. data/tools/staticdocs/docs/tools/data-viewer.html +32 -0
  132. data/tools/staticdocs/docs/tools/handbooks.html +16 -0
  133. data/tools/staticdocs/docs/tools/limits-monitor.html +30 -0
  134. data/tools/staticdocs/docs/tools/packet-viewer.html +37 -0
  135. data/tools/staticdocs/docs/tools/script-runner.html +91 -0
  136. data/tools/staticdocs/docs/tools/table-manager.html +34 -0
  137. data/tools/staticdocs/docs/tools/tlm-grapher.html +61 -0
  138. data/tools/staticdocs/docs/tools/tlm-viewer.html +45 -0
  139. data/tools/staticdocs/docs/tools.html +13 -0
  140. data/tools/staticdocs/docs/v5/bridges/index.html +11 -0
  141. data/tools/staticdocs/docs/v5/bucket-explorer/index.html +11 -0
  142. data/tools/staticdocs/docs/v5/calendar/index.html +11 -0
  143. data/tools/staticdocs/docs/v5/cfs/index.html +11 -0
  144. data/tools/staticdocs/docs/v5/cmd-sender/index.html +11 -0
  145. data/tools/staticdocs/docs/v5/cmd-tlm-server/index.html +11 -0
  146. data/tools/staticdocs/docs/v5/command/index.html +11 -0
  147. data/tools/staticdocs/docs/v5/contributing/index.html +11 -0
  148. data/tools/staticdocs/docs/v5/custom-widgets/index.html +11 -0
  149. data/tools/staticdocs/docs/v5/data-extractor/index.html +11 -0
  150. data/tools/staticdocs/docs/v5/data-viewer/index.html +11 -0
  151. data/tools/staticdocs/docs/v5/development/index.html +11 -0
  152. data/tools/staticdocs/docs/v5/format/index.html +11 -0
  153. data/tools/staticdocs/docs/v5/gettingstarted/index.html +11 -0
  154. data/tools/staticdocs/docs/v5/handbooks/index.html +11 -0
  155. data/tools/staticdocs/docs/v5/host-install/index.html +11 -0
  156. data/tools/staticdocs/docs/v5/index.html +11 -0
  157. data/tools/staticdocs/docs/v5/installation/index.html +11 -0
  158. data/tools/staticdocs/docs/v5/interfaces/index.html +11 -0
  159. data/tools/staticdocs/docs/v5/json-api/index.html +11 -0
  160. data/tools/staticdocs/docs/v5/limits-monitor/index.html +11 -0
  161. data/tools/staticdocs/docs/v5/little-endian-bitfields/index.html +11 -0
  162. data/tools/staticdocs/docs/v5/local-mode/index.html +11 -0
  163. data/tools/staticdocs/docs/v5/log-structure/index.html +11 -0
  164. data/tools/staticdocs/docs/v5/logging/index.html +11 -0
  165. data/tools/staticdocs/docs/v5/monitoring/index.html +11 -0
  166. data/tools/staticdocs/docs/v5/packet-viewer/index.html +11 -0
  167. data/tools/staticdocs/docs/v5/performance/index.html +11 -0
  168. data/tools/staticdocs/docs/v5/philosophy/index.html +11 -0
  169. data/tools/staticdocs/docs/v5/plugins/index.html +11 -0
  170. data/tools/staticdocs/docs/v5/podman/index.html +11 -0
  171. data/tools/staticdocs/docs/v5/protocols/index.html +11 -0
  172. data/tools/staticdocs/docs/v5/raspberrypi/index.html +11 -0
  173. data/tools/staticdocs/docs/v5/requirements/index.html +11 -0
  174. data/tools/staticdocs/docs/v5/roadmap/index.html +11 -0
  175. data/tools/staticdocs/docs/v5/script-runner/index.html +11 -0
  176. data/tools/staticdocs/docs/v5/script-writing/index.html +11 -0
  177. data/tools/staticdocs/docs/v5/scripting-api/index.html +11 -0
  178. data/tools/staticdocs/docs/v5/ssl-tls/index.html +11 -0
  179. data/tools/staticdocs/docs/v5/streaming-api/index.html +11 -0
  180. data/tools/staticdocs/docs/v5/table/index.html +11 -0
  181. data/tools/staticdocs/docs/v5/table-manager/index.html +11 -0
  182. data/tools/staticdocs/docs/v5/target/index.html +11 -0
  183. data/tools/staticdocs/docs/v5/telemetry/index.html +11 -0
  184. data/tools/staticdocs/docs/v5/telemetry-screens/index.html +11 -0
  185. data/tools/staticdocs/docs/v5/testing/index.html +11 -0
  186. data/tools/staticdocs/docs/v5/tlm-grapher/index.html +11 -0
  187. data/tools/staticdocs/docs/v5/tlm-viewer/index.html +11 -0
  188. data/tools/staticdocs/docs/v5/tools/index.html +11 -0
  189. data/tools/staticdocs/docs/v5/upgrading/index.html +11 -0
  190. data/tools/staticdocs/docs/v5/xtce/index.html +11 -0
  191. data/tools/staticdocs/docs.html +34 -0
  192. data/tools/staticdocs/index.html +13 -0
  193. data/tools/staticdocs/lunr-index-1702922896263.json +1 -0
  194. data/tools/staticdocs/lunr-index.json +1 -0
  195. data/tools/staticdocs/markdown-page.html +14 -0
  196. data/tools/staticdocs/search-doc-1702922896263.json +1 -0
  197. data/tools/staticdocs/search-doc.json +1 -0
  198. data/tools/staticdocs/sitemap.xml +1 -0
  199. metadata +432 -428
  200. data/tools/docs/404.html +0 -16
  201. data/tools/docs/assets/css/styles.7bc79028.css +0 -1
  202. data/tools/docs/assets/js/019369f3.bb600de8.js +0 -1
  203. data/tools/docs/assets/js/058ffc22.ce27f074.js +0 -1
  204. data/tools/docs/assets/js/0686a885.5fe3bfd4.js +0 -1
  205. data/tools/docs/assets/js/078dbab0.0a98e0c9.js +0 -1
  206. data/tools/docs/assets/js/0f5d161c.3a7b00e4.js +0 -1
  207. data/tools/docs/assets/js/0ff569c9.930bab08.js +0 -1
  208. data/tools/docs/assets/js/103cc3be.451dd416.js +0 -1
  209. data/tools/docs/assets/js/13196248.1be5ac81.js +0 -1
  210. data/tools/docs/assets/js/13c1b4e4.ad24c4f6.js +0 -1
  211. data/tools/docs/assets/js/15a39a64.4138456c.js +0 -1
  212. data/tools/docs/assets/js/2029.9e268a82.js +0 -1
  213. data/tools/docs/assets/js/2047b354.7995865f.js +0 -1
  214. data/tools/docs/assets/js/22b3ac48.73a6c979.js +0 -1
  215. data/tools/docs/assets/js/2846.a87f3fc4.js +0 -1
  216. data/tools/docs/assets/js/3477.783e2e37.js +0 -2
  217. data/tools/docs/assets/js/3dd7ef3b.8f77876c.js +0 -1
  218. data/tools/docs/assets/js/3df159b4.dded3e78.js +0 -1
  219. data/tools/docs/assets/js/40365d27.9322abd8.js +0 -1
  220. data/tools/docs/assets/js/411898ad.a1d949a2.js +0 -1
  221. data/tools/docs/assets/js/42170351.46c774f8.js +0 -1
  222. data/tools/docs/assets/js/43652efd.cbac4bc0.js +0 -1
  223. data/tools/docs/assets/js/5109.6a372217.js +0 -1
  224. data/tools/docs/assets/js/54d0d530.e9c8193b.js +0 -1
  225. data/tools/docs/assets/js/5bc719f6.fce76244.js +0 -1
  226. data/tools/docs/assets/js/5c6ce5ec.f909714f.js +0 -1
  227. data/tools/docs/assets/js/5e3ed378.cdfe0362.js +0 -1
  228. data/tools/docs/assets/js/5fe211ef.809c3f96.js +0 -1
  229. data/tools/docs/assets/js/6831b732.735c11e9.js +0 -1
  230. data/tools/docs/assets/js/696b4199.ff9185d0.js +0 -1
  231. data/tools/docs/assets/js/6b210247.248680ef.js +0 -1
  232. data/tools/docs/assets/js/6b65133b.2144fb1b.js +0 -1
  233. data/tools/docs/assets/js/6f92e431.608f28e7.js +0 -1
  234. data/tools/docs/assets/js/72c6d8a8.062b7650.js +0 -1
  235. data/tools/docs/assets/js/75e64983.d42f03f8.js +0 -1
  236. data/tools/docs/assets/js/7efc9fb0.6164fbad.js +0 -1
  237. data/tools/docs/assets/js/867640d5.28196e2c.js +0 -1
  238. data/tools/docs/assets/js/89e76475.5131b624.js +0 -1
  239. data/tools/docs/assets/js/8f7843ee.69e537b0.js +0 -1
  240. data/tools/docs/assets/js/9424f0b3.73086bed.js +0 -1
  241. data/tools/docs/assets/js/97535711.c7556831.js +0 -1
  242. data/tools/docs/assets/js/99581c43.30aef54d.js +0 -1
  243. data/tools/docs/assets/js/9d6e81d0.84fe3bb3.js +0 -1
  244. data/tools/docs/assets/js/9fb6059a.dc4760ab.js +0 -1
  245. data/tools/docs/assets/js/a182b3b3.25afec82.js +0 -1
  246. data/tools/docs/assets/js/a507c363.71a89240.js +0 -1
  247. data/tools/docs/assets/js/a677c089.2ec103f7.js +0 -1
  248. data/tools/docs/assets/js/a9987364.de63d165.js +0 -1
  249. data/tools/docs/assets/js/aa6b6c1b.6b24256f.js +0 -1
  250. data/tools/docs/assets/js/ada50b5c.1c75d3de.js +0 -1
  251. data/tools/docs/assets/js/b4596165.ab1c689f.js +0 -1
  252. data/tools/docs/assets/js/b6d70f94.ec27318b.js +0 -1
  253. data/tools/docs/assets/js/b9f60ba6.bb514133.js +0 -1
  254. data/tools/docs/assets/js/bd0034eb.0c60929d.js +0 -1
  255. data/tools/docs/assets/js/c24eae19.12176204.js +0 -1
  256. data/tools/docs/assets/js/cb8c3f08.762bb287.js +0 -1
  257. data/tools/docs/assets/js/cd879be4.3641a5cb.js +0 -1
  258. data/tools/docs/assets/js/d1b923aa.bf4b0c9e.js +0 -1
  259. data/tools/docs/assets/js/d24bf9b6.6ed3b576.js +0 -1
  260. data/tools/docs/assets/js/d370d7a7.28ef1aad.js +0 -1
  261. data/tools/docs/assets/js/d57a4b5d.017675ee.js +0 -1
  262. data/tools/docs/assets/js/d5d77c37.f472b18b.js +0 -1
  263. data/tools/docs/assets/js/d5f295fb.e008c3ec.js +0 -1
  264. data/tools/docs/assets/js/d7c988eb.2670948e.js +0 -1
  265. data/tools/docs/assets/js/d8ca4191.717db664.js +0 -1
  266. data/tools/docs/assets/js/d9b92eba.5eff70b2.js +0 -1
  267. data/tools/docs/assets/js/db8fa1d0.85784608.js +0 -1
  268. data/tools/docs/assets/js/dc5f7beb.120c148d.js +0 -1
  269. data/tools/docs/assets/js/e501b0d1.ae564e73.js +0 -1
  270. data/tools/docs/assets/js/f15615f1.3126a842.js +0 -1
  271. data/tools/docs/assets/js/fd886806.d2d0bdf4.js +0 -1
  272. data/tools/docs/assets/js/main.b5a535c2.js +0 -2
  273. data/tools/docs/assets/js/runtime~main.e3a6c705.js +0 -1
  274. data/tools/docs/docs/configuration/command.html +0 -40
  275. data/tools/docs/docs/configuration/format.html +0 -16
  276. data/tools/docs/docs/configuration/interfaces.html +0 -16
  277. data/tools/docs/docs/configuration/plugins.html +0 -17
  278. data/tools/docs/docs/configuration/protocols.html +0 -23
  279. data/tools/docs/docs/configuration/ssl-tls.html +0 -17
  280. data/tools/docs/docs/configuration/table.html +0 -30
  281. data/tools/docs/docs/configuration/target.html +0 -16
  282. data/tools/docs/docs/configuration/telemetry-screens.html +0 -36
  283. data/tools/docs/docs/configuration/telemetry.html +0 -16
  284. data/tools/docs/docs/configuration.html +0 -16
  285. data/tools/docs/docs/development/curl.html +0 -16
  286. data/tools/docs/docs/development/developing.html +0 -19
  287. data/tools/docs/docs/development/host-install.html +0 -16
  288. data/tools/docs/docs/development/json-api.html +0 -16
  289. data/tools/docs/docs/development/log-structure.html +0 -17
  290. data/tools/docs/docs/development/roadmap.html +0 -16
  291. data/tools/docs/docs/development/streaming-api.html +0 -18
  292. data/tools/docs/docs/development/testing.html +0 -16
  293. data/tools/docs/docs/development.html +0 -16
  294. data/tools/docs/docs/getting-started/gettingstarted.html +0 -16
  295. data/tools/docs/docs/getting-started/installation.html +0 -18
  296. data/tools/docs/docs/getting-started/podman.html +0 -18
  297. data/tools/docs/docs/getting-started/requirements.html +0 -16
  298. data/tools/docs/docs/getting-started/upgrading.html +0 -16
  299. data/tools/docs/docs/getting-started.html +0 -16
  300. data/tools/docs/docs/guides/bridges.html +0 -23
  301. data/tools/docs/docs/guides/cfs.html +0 -46
  302. data/tools/docs/docs/guides/custom-widgets.html +0 -16
  303. data/tools/docs/docs/guides/little-endian-bitfields.html +0 -16
  304. data/tools/docs/docs/guides/local-mode.html +0 -16
  305. data/tools/docs/docs/guides/logging.html +0 -16
  306. data/tools/docs/docs/guides/monitoring.html +0 -16
  307. data/tools/docs/docs/guides/performance.html +0 -16
  308. data/tools/docs/docs/guides/raspberrypi.html +0 -16
  309. data/tools/docs/docs/guides/script-writing.html +0 -18
  310. data/tools/docs/docs/guides/scripting-api.html +0 -17
  311. data/tools/docs/docs/guides.html +0 -16
  312. data/tools/docs/docs/meta/contributing.html +0 -20
  313. data/tools/docs/docs/meta/philosophy.html +0 -16
  314. data/tools/docs/docs/meta/xtce.html +0 -16
  315. data/tools/docs/docs/meta.html +0 -16
  316. data/tools/docs/docs/privacy.html +0 -23
  317. data/tools/docs/docs/tools/autonomic.html +0 -16
  318. data/tools/docs/docs/tools/bucket-explorer.html +0 -16
  319. data/tools/docs/docs/tools/calendar.html +0 -16
  320. data/tools/docs/docs/tools/cmd-sender.html +0 -16
  321. data/tools/docs/docs/tools/cmd-tlm-server.html +0 -17
  322. data/tools/docs/docs/tools/data-extractor.html +0 -16
  323. data/tools/docs/docs/tools/data-viewer.html +0 -16
  324. data/tools/docs/docs/tools/handbooks.html +0 -16
  325. data/tools/docs/docs/tools/limits-monitor.html +0 -16
  326. data/tools/docs/docs/tools/packet-viewer.html +0 -16
  327. data/tools/docs/docs/tools/script-runner.html +0 -16
  328. data/tools/docs/docs/tools/table-manager.html +0 -16
  329. data/tools/docs/docs/tools/tlm-grapher.html +0 -16
  330. data/tools/docs/docs/tools/tlm-viewer.html +0 -17
  331. data/tools/docs/docs/tools.html +0 -16
  332. data/tools/docs/docs/v5/bridges/index.html +0 -11
  333. data/tools/docs/docs/v5/bucket-explorer/index.html +0 -11
  334. data/tools/docs/docs/v5/calendar/index.html +0 -11
  335. data/tools/docs/docs/v5/cfs/index.html +0 -11
  336. data/tools/docs/docs/v5/cmd-sender/index.html +0 -11
  337. data/tools/docs/docs/v5/cmd-tlm-server/index.html +0 -11
  338. data/tools/docs/docs/v5/command/index.html +0 -11
  339. data/tools/docs/docs/v5/contributing/index.html +0 -11
  340. data/tools/docs/docs/v5/custom-widgets/index.html +0 -11
  341. data/tools/docs/docs/v5/data-extractor/index.html +0 -11
  342. data/tools/docs/docs/v5/data-viewer/index.html +0 -11
  343. data/tools/docs/docs/v5/development/index.html +0 -11
  344. data/tools/docs/docs/v5/format/index.html +0 -11
  345. data/tools/docs/docs/v5/gettingstarted/index.html +0 -11
  346. data/tools/docs/docs/v5/handbooks/index.html +0 -11
  347. data/tools/docs/docs/v5/host-install/index.html +0 -11
  348. data/tools/docs/docs/v5/index.html +0 -11
  349. data/tools/docs/docs/v5/installation/index.html +0 -11
  350. data/tools/docs/docs/v5/interfaces/index.html +0 -11
  351. data/tools/docs/docs/v5/json-api/index.html +0 -11
  352. data/tools/docs/docs/v5/limits-monitor/index.html +0 -11
  353. data/tools/docs/docs/v5/little-endian-bitfields/index.html +0 -11
  354. data/tools/docs/docs/v5/local-mode/index.html +0 -11
  355. data/tools/docs/docs/v5/log-structure/index.html +0 -11
  356. data/tools/docs/docs/v5/logging/index.html +0 -11
  357. data/tools/docs/docs/v5/monitoring/index.html +0 -11
  358. data/tools/docs/docs/v5/packet-viewer/index.html +0 -11
  359. data/tools/docs/docs/v5/performance/index.html +0 -11
  360. data/tools/docs/docs/v5/philosophy/index.html +0 -11
  361. data/tools/docs/docs/v5/plugins/index.html +0 -11
  362. data/tools/docs/docs/v5/podman/index.html +0 -11
  363. data/tools/docs/docs/v5/protocols/index.html +0 -11
  364. data/tools/docs/docs/v5/raspberrypi/index.html +0 -11
  365. data/tools/docs/docs/v5/requirements/index.html +0 -11
  366. data/tools/docs/docs/v5/roadmap/index.html +0 -11
  367. data/tools/docs/docs/v5/script-runner/index.html +0 -11
  368. data/tools/docs/docs/v5/script-writing/index.html +0 -11
  369. data/tools/docs/docs/v5/scripting-api/index.html +0 -11
  370. data/tools/docs/docs/v5/ssl-tls/index.html +0 -11
  371. data/tools/docs/docs/v5/streaming-api/index.html +0 -11
  372. data/tools/docs/docs/v5/table/index.html +0 -11
  373. data/tools/docs/docs/v5/table-manager/index.html +0 -11
  374. data/tools/docs/docs/v5/target/index.html +0 -11
  375. data/tools/docs/docs/v5/telemetry/index.html +0 -11
  376. data/tools/docs/docs/v5/telemetry-screens/index.html +0 -11
  377. data/tools/docs/docs/v5/testing/index.html +0 -11
  378. data/tools/docs/docs/v5/tlm-grapher/index.html +0 -11
  379. data/tools/docs/docs/v5/tlm-viewer/index.html +0 -11
  380. data/tools/docs/docs/v5/tools/index.html +0 -11
  381. data/tools/docs/docs/v5/upgrading/index.html +0 -11
  382. data/tools/docs/docs/v5/xtce/index.html +0 -11
  383. data/tools/docs/docs.html +0 -25
  384. data/tools/docs/index.html +0 -16
  385. data/tools/docs/lunr-index-1699630949575.json +0 -1
  386. data/tools/docs/lunr-index.json +0 -1
  387. data/tools/docs/markdown-page.html +0 -16
  388. data/tools/docs/search-doc-1699630949575.json +0 -1
  389. data/tools/docs/search-doc.json +0 -1
  390. data/tools/docs/sitemap.xml +0 -1
  391. /data/tools/{docs → staticdocs}/CNAME +0 -0
  392. /data/tools/{docs → staticdocs}/assets/images/add_packet-f318d0e92e8a13bd56331350aa341c88c8b12f2c54a4424f6e287817f22fb327.png +0 -0
  393. /data/tools/{docs → staticdocs}/assets/images/architecture-b78f12eba076a0c07af7abdd9dd4187c59aa6b4f5c51b47ad03f73e9f98a6ed6.png +0 -0
  394. /data/tools/{docs → staticdocs}/assets/images/autonomic-3d6d152f700c8fc1878d0f952d013ace31fccd7872d28587dc761610a0959e9c.png +0 -0
  395. /data/tools/{docs → staticdocs}/assets/images/bucket_explorer-983c087ee3bdcf8626219e782620b6c580fd82bfe2e8b0c662a0f90cdca43838.png +0 -0
  396. /data/tools/{docs → staticdocs}/assets/images/calendar-9fbd635cf3df1ba684bb0c1ebc4f6ad34991efc582e9fd07820c8b74cbb66aa1.png +0 -0
  397. /data/tools/{docs → staticdocs}/assets/images/checks_rb-a6049cdd99613cea2ee12d76fcfe798ff05270e39d208e93d37da7347049b2b3.png +0 -0
  398. /data/tools/{docs → staticdocs}/assets/images/cmd_tlm_server-313e3f64afc0e374d9d28b46364235d7b793001f84690fc0ae90e1eefdd9142d.png +0 -0
  399. /data/tools/{docs → staticdocs}/assets/images/command_sender-a0b113b65368263529d0f8f2d93276a0a44ed81af0d0100f56379346ba592928.png +0 -0
  400. /data/tools/{docs → staticdocs}/assets/images/commands-3608d5c856fd34e771d1f9e69f9f449f52929249bdf4f0e7feed0aa2bd2d9fd7.png +0 -0
  401. /data/tools/{docs → staticdocs}/assets/images/connecting-6e453f3d99800d4cb8fdc78f5b8fce1e8cf1bb04840a29dec7c5caefd07c004f.png +0 -0
  402. /data/tools/{docs → staticdocs}/assets/images/data_extractor-62c5b1743ba9dfdff2e393bcbdf863c36effc5ef5319d845cfd17186bd757bca.png +0 -0
  403. /data/tools/{docs → staticdocs}/assets/images/data_viewer-8c547cb5ad2ebd179aac5e46c2f4c147889ebad53a5359a5e6b6c580de7184fe.png +0 -0
  404. /data/tools/{docs → staticdocs}/assets/images/date_chooser-10f7b740b9acc76604e5dc86fe409b6b777abe0fb3fa5ebf8f47cb1ac58b9676.png +0 -0
  405. /data/tools/{docs → staticdocs}/assets/images/debug-04088348cc04bb8e1a1063fc44920dc8e39616840ef4b09a36c823f185c28669.png +0 -0
  406. /data/tools/{docs → staticdocs}/assets/images/delete_all_mouseover-06083f3d3d712d39f21bc5eda45adbfff449732a2061e53cb1a0baf6c5f5d4b8.png +0 -0
  407. /data/tools/{docs → staticdocs}/assets/images/delete_modified-a7ec0ceb61c37398d57fcecf11ebe2453ebd0110be6cfc960a5073a13a557638.png +0 -0
  408. /data/tools/{docs → staticdocs}/assets/images/edit_all_items-2c57aff19d3b1ce52149c37f50dcaad8c30baa0c9931fdc629f1d163bb56ce96.png +0 -0
  409. /data/tools/{docs → staticdocs}/assets/images/edit_all_mouseover-f6646df5320045ee10d4c0a15d0349fed6ede075f9cea6f9e449b3785c4f4f8d.png +0 -0
  410. /data/tools/{docs → staticdocs}/assets/images/edit_graph-4ca61635376fae26cf5eb82fb9fd803f1a51c4d3584aaf9833a270b7916bf531.png +0 -0
  411. /data/tools/{docs → staticdocs}/assets/images/edit_screen-5724ae13958c1631b3c187cf7cdb6dc9672ecd71f8b0786ac17c0266001edac3.png +0 -0
  412. /data/tools/{docs → staticdocs}/assets/images/edit_temp1-7446e7c5b7869ccc9ddd467779fa86f44301a5e5896751b016a527587c483cb2.png +0 -0
  413. /data/tools/{docs → staticdocs}/assets/images/file_menu-2fe13872737c0f3fef84ba5b58b80b609082733acce536ec1f56910c36f68299.png +0 -0
  414. /data/tools/{docs → staticdocs}/assets/images/file_open-319761fd383fc513b3689ef0a7498c73ce9459a3967c8a395cc2da07c89240d0.png +0 -0
  415. /data/tools/{docs → staticdocs}/assets/images/file_save_as-44468ed6a48bea3bc4fdd8f50d802569e4582b453e5bf946bfdcba400030d499.png +0 -0
  416. /data/tools/{docs → staticdocs}/assets/images/four_graphs-826cf8145338fa46e037556df94c59aeb4448330b601953daa94c89de8494cfd.png +0 -0
  417. /data/tools/{docs → staticdocs}/assets/images/graph_min_max-80a2bd83230c71b00ba9d6da24b8c32a09e4983976cdbf32c33d2680b534b106.png +0 -0
  418. /data/tools/{docs → staticdocs}/assets/images/graph_temp1-de937a79b314cf856b783c936d2460a6c942bdd45e4d9b3fe488957df5bfa9bc.png +0 -0
  419. /data/tools/{docs → staticdocs}/assets/images/graph_temp1_temp2-e96370f7d73a6cb68beaa92bcaaf18b72e6619ce948fe835762cca1048efbd18.png +0 -0
  420. /data/tools/{docs → staticdocs}/assets/images/graph_temp1_time-fec5e99e3cc05ea87208abe9c4b66b63b7497bbefee55f65d034417e966b1c46.png +0 -0
  421. /data/tools/{docs → staticdocs}/assets/images/handbooks-1d301c83c80a7cb96c548006f5139fe8ec967ed10a49df0142b37328cd987f33.png +0 -0
  422. /data/tools/{docs → staticdocs}/assets/images/ignored-1e20d4ffe7fd88ffab610340957b1176294269f985e8fdb20a9af07d7a78215f.png +0 -0
  423. /data/tools/{docs → staticdocs}/assets/images/inst_clear-5ecb859f06f14d91d2ebba27e5a7848d6393db5ad2357f95c12e776c45f6bc64.png +0 -0
  424. /data/tools/{docs → staticdocs}/assets/images/inst_collect-4f4e453a6521b779e10c4d2be6a8b1acf15fcb083af0164b0df1de27ca250132.png +0 -0
  425. /data/tools/{docs → staticdocs}/assets/images/inst_collect_hazardous-3aeabedb96bf114b4eb56b6b2ee7bcc601302ec8905a82a16c47ae7870f97978.png +0 -0
  426. /data/tools/{docs → staticdocs}/assets/images/inst_collect_hazardous_history-952a6e6ff2fb1b5fdf2c6b3d84a3ccf9e303eeb310f35514dc4a6e95f2a7420e.png +0 -0
  427. /data/tools/{docs → staticdocs}/assets/images/inst_collect_sent-0de429f724264ce8c52a6cb22d4bbb96f14e22b559c091ff4375bb59f124a7a2.png +0 -0
  428. /data/tools/{docs → staticdocs}/assets/images/inst_collect_sent_3-91cf4e053d246917964330ab93534a0a5eb878b652e7ea879effca7c4eaefbea.png +0 -0
  429. /data/tools/{docs → staticdocs}/assets/images/interface_read_logic-0deef27c1d2fec9de2a3720a3c9ecedb21a00dca7aabd13da0b8815c037e4c26.png +0 -0
  430. /data/tools/{docs → staticdocs}/assets/images/interface_write_logic-3360afe1b4af20b10dafba848a21e09baccaacc06e2ec8b6c132ac7a3c99e994.png +0 -0
  431. /data/tools/{docs → staticdocs}/assets/images/interfaces-5622abf50e3df63980661a48216bf71187f38cb636bd512f48917ca4a425f083.png +0 -0
  432. /data/tools/{docs → staticdocs}/assets/images/items_table-2fc1bb4d03a2348c4af7df442e13cee2f310cf455228005d76cbfda7a706aa53.png +0 -0
  433. /data/tools/{docs → staticdocs}/assets/images/items_table_raw-c4d454679c4503ec35710dcee6be5cd1940984595145b333d8604bc505dfe291.png +0 -0
  434. /data/tools/{docs → staticdocs}/assets/images/items_table_temp1-ea091eaf8005cea839800f4514f72f94e9664993111b935f33e7c5aa3061ca64.png +0 -0
  435. /data/tools/{docs → staticdocs}/assets/images/limits_monitor-c58d70daea7586b93d5069b9df068a90cea5f7cf2e51a445f3162bf3f66db3d0.png +0 -0
  436. /data/tools/{docs → staticdocs}/assets/images/list_view-926f42bc1e43283c61616b0cd8fd630cad8e15c9b7298acd98536842472e673b.png +0 -0
  437. /data/tools/{docs → staticdocs}/assets/images/log-ba64fd307e53adafae55fcea7eb31829ee1aacdf4aafe8b40b270b793be3aa27.png +0 -0
  438. /data/tools/{docs → staticdocs}/assets/images/log_messages-19c3ce9c7ff86e43d459cb6591df8c05d25e1390d857728cb462a57b9d3ccc69.png +0 -0
  439. /data/tools/{docs → staticdocs}/assets/images/log_messages-2cfad0fd6f6f980f69b5564a4b7ecfecf3331c6256c78bcfb2b084970db305ca.png +0 -0
  440. /data/tools/{docs → staticdocs}/assets/images/minimized-59d0d8d8a179ff0475787e87237b77b24d59d78826d43dbc1a554a51380eb37f.png +0 -0
  441. /data/tools/{docs → staticdocs}/assets/images/minimized-a658bd8f2115d3f9a386844e886de770b23bbf9c0c8c55a4ca587cea67ec320e.png +0 -0
  442. /data/tools/{docs → staticdocs}/assets/images/minio-150460ac77a50711835de6f0150d019000e5515afae0f3adfcdda8e891484f47.png +0 -0
  443. /data/tools/{docs → staticdocs}/assets/images/mouseover-95b774047b3c2ca23a3bc645caf75d90511c378729dd9cfb781510a1452e09fe.png +0 -0
  444. /data/tools/{docs → staticdocs}/assets/images/new_screen-295720ec60219194c8c8dd64c755e8a188cc4a68c2b6cf66197b54514644d52a.png +0 -0
  445. /data/tools/{docs → staticdocs}/assets/images/notifications-5b32d6619542431027ddd67491eb445469fa2d16fa8352a2b0917b9298b7bbb2.png +0 -0
  446. /data/tools/{docs → staticdocs}/assets/images/open_config-2e61415a3c2d7a4ce427cf325f3708dd4a761092b7dd0c869279c4354dc34ae4.png +0 -0
  447. /data/tools/{docs → staticdocs}/assets/images/open_config-3cd3be1ce4560d9e72bb37b83dc830149091dec9a088c36187e0e72660c6ec34.png +0 -0
  448. /data/tools/{docs → staticdocs}/assets/images/open_config-55ef2f241d02047b252bb8201742f99cffed5680d0e9eb46b3cb53a644ca3dc9.png +0 -0
  449. /data/tools/{docs → staticdocs}/assets/images/open_config-f848a8b371ae0ec31776834148e9f978d9be94efef03534e5ca3a59c0ae3847f.png +0 -0
  450. /data/tools/{docs → staticdocs}/assets/images/packet_viewer-19c1015cc704a98d1f6d90dd0dadc13188d25f1d5d2e838b7cfb226e8c173c7b.png +0 -0
  451. /data/tools/{docs → staticdocs}/assets/images/plugin-variables-5bc00c744182c9a9591e84cb3bbb1c4deb53ff22e05f62ce1b807c26bed782e5.png +0 -0
  452. /data/tools/{docs → staticdocs}/assets/images/processing-b0c50908284739a76e1bbcfcb3eb34dc9446f8716117cb0e9089ad9df53ebed6.png +0 -0
  453. /data/tools/{docs → staticdocs}/assets/images/project-fe7ac90f3e45971fca8f1be94be9dbabe494bafe705e7f8f485676e9d96e47ea.png +0 -0
  454. /data/tools/{docs → staticdocs}/assets/images/project_update-8e7de3b0658b95d4d9931eb52ff8bf339d633cbdc273ce096eb11ceb357c009e.png +0 -0
  455. /data/tools/{docs → staticdocs}/assets/images/raw_command-759d93759a73a6a3dd7e30f89fc4d1a544dfb6f7355abfed03897d404279161d.png +0 -0
  456. /data/tools/{docs → staticdocs}/assets/images/raw_telemetry-ffeb6b603f9a9abbe0cb77afaaeb4b4f07dfee479682a5c9661f85589a679049.png +0 -0
  457. /data/tools/{docs → staticdocs}/assets/images/raw_tlm_logs-8dcba4f020b36f8efbb793271b70d40d9cad627196afaeb5bf6f3931ed53fa52.png +0 -0
  458. /data/tools/{docs → staticdocs}/assets/images/reactions-dd4a8ebf22eed921a82a5478d23178c62e2cf944d295c2b9e3f4d7ce555b0fcc.png +0 -0
  459. /data/tools/{docs → staticdocs}/assets/images/reload_file-8e26cd3e1bc1eab7bb6c046d9a6a8231fcd76e56682d819b1e549182890c6486.png +0 -0
  460. /data/tools/{docs → staticdocs}/assets/images/reloaded-9effa15527244928ee503eb0c3a48cc5e82c07cfb5d5c4300eacfcab913069d1.png +0 -0
  461. /data/tools/{docs → staticdocs}/assets/images/running_scripts-78bfd36a6c8c7167234e03bd188e974927c2beea1f730498583169a81639e7a3.png +0 -0
  462. /data/tools/{docs → staticdocs}/assets/images/save_config-0ae36ac1f8114665f2558e936ba3b30e5cba2a16cc01d3494e14ed689b4637f7.png +0 -0
  463. /data/tools/{docs → staticdocs}/assets/images/save_config-8b028134b07c70d6de019825cbb328623fc485d72aad9ba5b1980246b316fec2.png +0 -0
  464. /data/tools/{docs → staticdocs}/assets/images/save_config-e4ed80276ebdc2c4eaf9aaeb859cff8aecb380b22da8c659741c31ca66914098.png +0 -0
  465. /data/tools/{docs → staticdocs}/assets/images/save_config-e748a338526ffd8f9e49def5c0d15f8a80cd987f40d210ff6c6d4b61b713555c.png +0 -0
  466. /data/tools/{docs → staticdocs}/assets/images/script_error-ce060b3086e7b466e51a276fb6b27245b4d042f07a60fe121b0071dd65a42075.png +0 -0
  467. /data/tools/{docs → staticdocs}/assets/images/script_runner-7d7f01b90be962b4de46c20568727c55488eec5d9844823b53a262c9cfc470fa.png +0 -0
  468. /data/tools/{docs → staticdocs}/assets/images/script_suite-42832d936f91417740b76a39841996c8e4a7cf5391dbb19abe9d7b31ab07dd7d.png +0 -0
  469. /data/tools/{docs → staticdocs}/assets/images/select_item-f063106a8d836656496ba81e7e7428f51bd8ab95aebab0aa4eb6ad41ed42e026.png +0 -0
  470. /data/tools/{docs → staticdocs}/assets/images/select_packet-0b6d5a2b012445ab2bf0fd3e1545f015cd7787280d05d2bccb0a9c9220102529.png +0 -0
  471. /data/tools/{docs → staticdocs}/assets/images/select_packet-be9d63c49f898cccb73f9e4b2b39c4b5879cead34a8ab2ede0bb08e953498e95.png +0 -0
  472. /data/tools/{docs → staticdocs}/assets/images/select_target-71ebcab6cbefafd8958939130861a75f7544e99a043d90fa0734ec2f983d835f.png +0 -0
  473. /data/tools/{docs → staticdocs}/assets/images/simple_screen-3c9d6d2366c716c03a301396a4ce0ea418532890f349d9bc9ebb8be90983a6e6.png +0 -0
  474. /data/tools/{docs → staticdocs}/assets/images/status-80010882300d2f1c453fbc4cb35bdb1f06d3db578266dda95c56ea7ec230ac72.png +0 -0
  475. /data/tools/{docs → staticdocs}/assets/images/table_manager-9a5357ce536102bc1bb0c859be552f4ac82f62e538935a3c45a8e76d4f9744db.png +0 -0
  476. /data/tools/{docs → staticdocs}/assets/images/targets-d15296b133787be4997c3d5e7d43eec9030831f1758508a8f6a71d40d04478ce.png +0 -0
  477. /data/tools/{docs → staticdocs}/assets/images/telemetry-3f1169fc67b3d2427047ba66a9b2f3ddf71f61edf498ee70d14e78f0ef3c1e3c.png +0 -0
  478. /data/tools/{docs → staticdocs}/assets/images/telemetry_grapher-a96b7e0101f5e377a73a186683e967e79d748c5dff2dfed6ec0afcea5694d7c8.png +0 -0
  479. /data/tools/{docs → staticdocs}/assets/images/telemetry_viewer-be6ee576f1efceb39c2f744889deb4c18f571c4922c69d5d0e5f49a653776a46.png +0 -0
  480. /data/tools/{docs → staticdocs}/assets/images/temp1_details-f0b6e62bc28da18febacc936112735e1dbd5718ef675668f04d8b3e060d7f87a.png +0 -0
  481. /data/tools/{docs → staticdocs}/assets/images/time_chooser-e4ca0705d5b97c3056b0de3ab7f71f8091482b9b2e8904e69866a43ce4e616f2.png +0 -0
  482. /data/tools/{docs → staticdocs}/assets/images/timeline_lifecycle-0bd916dee06bf67936b043abfdbc4d5fdec7cc5a32a889ee6c05e9faf74f4c6a.png +0 -0
  483. /data/tools/{docs → staticdocs}/assets/images/triggers-0b0b3f9cc2850c1b83b9a7aab6f8a936626fd847c3158e993e4baa0e64b38096.png +0 -0
  484. /data/tools/{docs → staticdocs}/assets/images/two_full_height-7cf9d0bbdf0269ad85e312f6dcb77930e1e3c4319f9750968a9347fafcf26084.png +0 -0
  485. /data/tools/{docs → staticdocs}/assets/images/two_full_width-db2d88c0e2e6fc417016f47e3bac0bf68374957d8fc014220f53870429ea1ef3.png +0 -0
  486. /data/tools/{docs → staticdocs}/assets/images/view_portal-b2e5fef00be80f1551b965d170fc3cd8ed95597f0a1e475a8177ab2d306215f5.png +0 -0
  487. /data/tools/{docs → staticdocs}/assets/images/view_portal_add-56f06135fc56f1fa85cbc22ea3b7ad52f311641aad25df08b6f4a6f979b30e3f.png +0 -0
  488. /data/tools/{docs → staticdocs}/assets/js/1131.f9e1547d.js +0 -0
  489. /data/tools/{docs → staticdocs}/assets/js/2923e883.0cbdcbc5.js +0 -0
  490. /data/tools/{docs/assets/js/3477.783e2e37.js.LICENSE.txt → staticdocs/assets/js/4657.9492019f.js.LICENSE.txt} +0 -0
  491. /data/tools/{docs → staticdocs}/assets/js/d797a795.9243eac2.js +0 -0
  492. /data/tools/{docs → staticdocs}/img/BCT.png +0 -0
  493. /data/tools/{docs → staticdocs}/img/OpenC3.png +0 -0
  494. /data/tools/{docs → staticdocs}/img/article-footer.png +0 -0
  495. /data/tools/{docs → staticdocs}/img/ball.jpg +0 -0
  496. /data/tools/{docs → staticdocs}/img/black_logo.svg +0 -0
  497. /data/tools/{docs → staticdocs}/img/captech.gif +0 -0
  498. /data/tools/{docs → staticdocs}/img/docusaurus-social-card.jpg +0 -0
  499. /data/tools/{docs → staticdocs}/img/docusaurus.png +0 -0
  500. /data/tools/{docs → staticdocs}/img/favicon.png +0 -0
  501. /data/tools/{docs → staticdocs}/img/footer-logo.png +0 -0
  502. /data/tools/{docs → staticdocs}/img/interface_read_logic.png +0 -0
  503. /data/tools/{docs → staticdocs}/img/interface_write_logic.png +0 -0
  504. /data/tools/{docs → staticdocs}/img/johnh.gif +0 -0
  505. /data/tools/{docs → staticdocs}/img/lockheed.png +0 -0
  506. /data/tools/{docs → staticdocs}/img/logo.svg +0 -0
  507. /data/tools/{docs → staticdocs}/img/nasa.gif +0 -0
  508. /data/tools/{docs → staticdocs}/img/sdlusu.gif +0 -0
  509. /data/tools/{docs → staticdocs}/img/v5/architecture.png +0 -0
  510. /data/tools/{docs → staticdocs}/img/v5/autonomic/autonomic.png +0 -0
  511. /data/tools/{docs → staticdocs}/img/v5/autonomic/reactions.png +0 -0
  512. /data/tools/{docs → staticdocs}/img/v5/autonomic/triggers.png +0 -0
  513. /data/tools/{docs → staticdocs}/img/v5/bucket_explorer/bucket_explorer.png +0 -0
  514. /data/tools/{docs → staticdocs}/img/v5/calendar/calendar.png +0 -0
  515. /data/tools/{docs → staticdocs}/img/v5/calendar/list_view.png +0 -0
  516. /data/tools/{docs → staticdocs}/img/v5/calendar/timeline_lifecycle.png +0 -0
  517. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/cmd_tlm_server.png +0 -0
  518. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/commands.png +0 -0
  519. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/file_menu.png +0 -0
  520. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/interfaces.png +0 -0
  521. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/log_messages.png +0 -0
  522. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/raw_command.png +0 -0
  523. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/raw_telemetry.png +0 -0
  524. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/routers.png +0 -0
  525. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/status.png +0 -0
  526. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/targets.png +0 -0
  527. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/telemetry.png +0 -0
  528. /data/tools/{docs → staticdocs}/img/v5/command_sender/command_sender.png +0 -0
  529. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_clear.png +0 -0
  530. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect.png +0 -0
  531. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_hazardous.png +0 -0
  532. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_hazardous_history.png +0 -0
  533. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_sent.png +0 -0
  534. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_sent_3.png +0 -0
  535. /data/tools/{docs → staticdocs}/img/v5/command_sender/mode_menu.png +0 -0
  536. /data/tools/{docs → staticdocs}/img/v5/contact/jason.png +0 -0
  537. /data/tools/{docs → staticdocs}/img/v5/contact/ryan.jpeg +0 -0
  538. /data/tools/{docs → staticdocs}/img/v5/data_extractor/data_extractor.png +0 -0
  539. /data/tools/{docs → staticdocs}/img/v5/data_extractor/date_chooser.png +0 -0
  540. /data/tools/{docs → staticdocs}/img/v5/data_extractor/delete_all_mouseover.png +0 -0
  541. /data/tools/{docs → staticdocs}/img/v5/data_extractor/download.png +0 -0
  542. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_all_items.png +0 -0
  543. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_all_mouseover.png +0 -0
  544. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_temp1.png +0 -0
  545. /data/tools/{docs → staticdocs}/img/v5/data_extractor/file_menu.png +0 -0
  546. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table.png +0 -0
  547. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table_raw.png +0 -0
  548. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table_temp1.png +0 -0
  549. /data/tools/{docs → staticdocs}/img/v5/data_extractor/mode_menu.png +0 -0
  550. /data/tools/{docs → staticdocs}/img/v5/data_extractor/open_config.png +0 -0
  551. /data/tools/{docs → staticdocs}/img/v5/data_extractor/processing.png +0 -0
  552. /data/tools/{docs → staticdocs}/img/v5/data_extractor/save_config.png +0 -0
  553. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_item.png +0 -0
  554. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_packet.png +0 -0
  555. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_target.png +0 -0
  556. /data/tools/{docs → staticdocs}/img/v5/data_extractor/time_chooser.png +0 -0
  557. /data/tools/{docs → staticdocs}/img/v5/data_viewer/add_packet.png +0 -0
  558. /data/tools/{docs → staticdocs}/img/v5/data_viewer/data_viewer.png +0 -0
  559. /data/tools/{docs → staticdocs}/img/v5/data_viewer/file_menu.png +0 -0
  560. /data/tools/{docs → staticdocs}/img/v5/data_viewer/open_config.png +0 -0
  561. /data/tools/{docs → staticdocs}/img/v5/data_viewer/rename_tab.png +0 -0
  562. /data/tools/{docs → staticdocs}/img/v5/data_viewer/save_config.png +0 -0
  563. /data/tools/{docs → staticdocs}/img/v5/data_viewer/tab_right_click.png +0 -0
  564. /data/tools/{docs → staticdocs}/img/v5/data_viewer/view_portal.png +0 -0
  565. /data/tools/{docs → staticdocs}/img/v5/data_viewer/view_portal_add.png +0 -0
  566. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/delete_modified.png +0 -0
  567. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/minio.png +0 -0
  568. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/project.png +0 -0
  569. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/project_update.png +0 -0
  570. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/reload_file.png +0 -0
  571. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/reloaded.png +0 -0
  572. /data/tools/{docs → staticdocs}/img/v5/guides/logging/browser.png +0 -0
  573. /data/tools/{docs → staticdocs}/img/v5/guides/logging/log_messages.png +0 -0
  574. /data/tools/{docs → staticdocs}/img/v5/guides/logging/notifications.png +0 -0
  575. /data/tools/{docs → staticdocs}/img/v5/guides/logging/raw_tlm_logs.png +0 -0
  576. /data/tools/{docs → staticdocs}/img/v5/guides/plugin-variables.png +0 -0
  577. /data/tools/{docs → staticdocs}/img/v5/guides/simple_screen.png +0 -0
  578. /data/tools/{docs → staticdocs}/img/v5/handbooks/handbooks.png +0 -0
  579. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/ignored.png +0 -0
  580. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/limits_monitor.png +0 -0
  581. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/log.png +0 -0
  582. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/mouseover.png +0 -0
  583. /data/tools/{docs → staticdocs}/img/v5/navigation.png +0 -0
  584. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/file_menu.png +0 -0
  585. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/packet_viewer.png +0 -0
  586. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/select_packet.png +0 -0
  587. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/temp1_details.png +0 -0
  588. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/view_menu.png +0 -0
  589. /data/tools/{docs → staticdocs}/img/v5/script_runner/checks_rb.png +0 -0
  590. /data/tools/{docs → staticdocs}/img/v5/script_runner/connecting.png +0 -0
  591. /data/tools/{docs → staticdocs}/img/v5/script_runner/debug.png +0 -0
  592. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_menu.png +0 -0
  593. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_open.png +0 -0
  594. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_save_as.png +0 -0
  595. /data/tools/{docs → staticdocs}/img/v5/script_runner/running_scripts.png +0 -0
  596. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_error.png +0 -0
  597. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_menu.png +0 -0
  598. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_runner.png +0 -0
  599. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_suite.png +0 -0
  600. /data/tools/{docs → staticdocs}/img/v5/table_manager/file_menu.png +0 -0
  601. /data/tools/{docs → staticdocs}/img/v5/table_manager/table_manager.png +0 -0
  602. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/edit_graph.png +0 -0
  603. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/file_menu.png +0 -0
  604. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/four_graphs.png +0 -0
  605. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_menu.png +0 -0
  606. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_min_max.png +0 -0
  607. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1.png +0 -0
  608. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1_temp2.png +0 -0
  609. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1_time.png +0 -0
  610. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/grapher_controls.png +0 -0
  611. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/minimized.png +0 -0
  612. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/open_config.png +0 -0
  613. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/save_config.png +0 -0
  614. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/stop_start.png +0 -0
  615. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/telemetry_grapher.png +0 -0
  616. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/two_full_height.png +0 -0
  617. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/two_full_width.png +0 -0
  618. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/edit_screen.png +0 -0
  619. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/file_menu.png +0 -0
  620. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/minimized.png +0 -0
  621. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/new_screen.png +0 -0
  622. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/open_config.png +0 -0
  623. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/save_config.png +0 -0
  624. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/telemetry_viewer.png +0 -0
data/tools/staticdocs/docs/configuration/plugins.html ADDED
@@ -0,0 +1,339 @@
1
+ <!doctype html>
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
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="generator" content="Docusaurus v3.0.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.6e885bef.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.6ca622b3.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.1b3209ca.js" defer="defer"></script>
9
+ </head>
10
+ <body class="navigation-with-keyboard">
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" 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
+ <p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
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
+ <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 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
+ <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 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
+ <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 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
+ <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 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
+ <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 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
+ <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 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 as follows:</p>
28
+ <table><thead><tr><th>Folder / File</th><th>Description</th></tr></thead><tbody><tr><td>plugin.txt</td><td>Configuration file for the plugin. This file is required and always named exactly plugin.txt. See later in this document for the format.</td></tr><tr><td>LICENSE.txt</td><td>License for the plugin. COSMOS Plugins should be licensed in a manner compatible with the AGPLv3, unless they are designed only for use with COSMOS Enterprise Edition (or only for use at Ball), in which case they can take on any license as desired.</td></tr><tr><td>openc3-PLUGINNAME.gemspec</td><td>This file should have the name of the plugin with a .gemspec extension. For example openc3-cosmos-demo.gemspec. The name of this file is used in compiling the plugin contents into the final corresponding PluginName-Version.gem plugin file. ie. openc3-cosmos-demo-5.0.0.gem. COSMOS plugins should always begin with the openc3- prefix to make them easily identifiable in the Rubygems repository. The contents of this file take on the Rubygems spec format as documented at: <a href="https://guides.rubygems.org/specification-reference/" target="_blank" rel="noopener noreferrer">https://guides.rubygems.org/specification-reference/</a></td></tr><tr><td>Rakefile</td><td>This is a helper ruby Rakefile used to build the plugin. In general, the exact same file as provided with the COSMOS demo plugins can be used, or other features can be added as necessary for your plugin project. This file is typically just used to support building the plugin by running &quot;rake build VERSION=X.X.X&quot; where X.X.X is the plugin version number. A working Ruby installation is required.</td></tr><tr><td>README.md</td><td>Use this file to describe your plugin. It is typically a markdown file that supports nice formatting on Github.</td></tr><tr><td>targets/</td><td>This folder is required if any targets are defined by your plugin. All target configuration is included under this folder. It should contain one or more target configurations</td></tr><tr><td>targets/TARGETNAME</td><td>This is a folder that contains the configuration for a specific target named TARGETNAME. The name is always defined in all caps. For example: targets/INST. This is typically the default name of the target, but well-designed targets will allow themselves to be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.</td></tr><tr><td>targets/TARGETNAME/cmd_tlm</td><td>This folder contains the command and telemetry definition files for the target. These files capture the format of the commands that can be sent to the target, and the telemetry packets that are expected to be received by COSMOS from the target. Note that the files in this folder are processed in alphabetical order by default. That can matter if you reference a packet in another file (it should already have been defined). See the Command and Telemetry Configuration Guides for more information.</td></tr><tr><td>targets/TARGETNAME/data</td><td>Use this folder to store any general data that is needed by the target excluding CANVAS image files.</td></tr><tr><td>targets/TARGETNAME/lib</td><td>This folder contains any custom code required by the target. Good examples of custom code are custom Interface classes and protocols. See the Interface documentation for more information. Try to give any custom code a unique filename that starts with the name of the target. This can help avoid name conflicts that can occur if two different targets create a custom code file with the same filename.</td></tr><tr><td>targets/TARGETNAME/procedures</td><td>This folder contains target specific procedures and helper methods which exercise functionality of the target. These procedures should be kept simple and only use the command and telemetry definitions associated with this target. See the Scripting Guide for more information.</td></tr><tr><td>targets/TARGETNAME/public</td><td>Put image files here for use in Telemetry Viewer Canvas Image widgets such as <a href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasimage">CANVASIMAGE</a> and <a href="/tools/staticdocs/docs/configuration/telemetry-screens#canvasimagevalue">CANVASIMAGEVALUE</a>.</td></tr><tr><td>targets/TARGETNAME/screens</td><td>This folder contains telemetry screens for the target. See Screen Configuration for more information.</td></tr><tr><td>targets/TARGETNAME/target.txt</td><td>This file contains target specific configuration such as which command parameters should be ignored by Command Sender. See Target Configuration for more information.</td></tr><tr><td>microservices/</td><td>This folder is required if any microservices are defined by your plugin. All microservice code and configuration is included in this folder. It should contain one or more MICROSERVICENAME subfolders</td></tr><tr><td>microservices/MICROSERVICENAME</td><td>This is a folder that contains the code and any necessary configuration for a specific microservice named MICROSERVICENAME. The name is always defined in all caps. For example: microservices/EXAMPLE. This is typically the default name of the microservice, but well-designed microservices will allow themselves to be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.</td></tr><tr><td>tools/</td><td>This folder is required if any tools are defined by your plugin. All tool code and configuration is included in this folder. It should contain one or more toolname subfolders</td></tr><tr><td>tools/toolname</td><td>This is a folder that contains all the files necessary to serve a web-based tool named toolname. The name is always defined in all lowercase. For example: tools/base. Due to technical limitations, the toolname must be unique and cannot be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.</td></tr></tbody></table>
29
+ <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>
30
+ <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.
31
+ 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>
32
+ <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>
33
+ <p><strong>Define a configurable variable for the plugin</strong></p>
34
+ <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>
35
+ <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>
36
+ <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>
37
+ <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>
38
+ <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>
39
+ <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>
40
+ <p><strong>Defines a connection to a physical target</strong></p>
41
+ <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>
42
+ <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>
43
+ <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
44
+ <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>
45
+ <p>The following keywords must follow a INTERFACE keyword.</p>
46
+ <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>
47
+ <p><strong>Maps a target name to an interface</strong></p>
48
+ <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>
49
+ <p>Example Usage:</p>
50
+ <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>
51
+ <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>
52
+ <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
53
+ <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>
54
+ <p>Example Usage:</p>
55
+ <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>
56
+ <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>
57
+ <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
58
+ <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>
59
+ <p>Example Usage:</p>
60
+ <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>
61
+ <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>
62
+ <p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
63
+ <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>
64
+ <p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
65
+ <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>
66
+ <p><strong>Reconnect delay in seconds</strong></p>
67
+ <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>
68
+ <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>
69
+ <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>
70
+ <p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
71
+ <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>
72
+ <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>
73
+ <p><strong>Deprecated, use LOG_STREAM</strong></p>
74
+ <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>
75
+ <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>
76
+ <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>
77
+ <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>
78
+ <p>Example Usage:</p>
79
+ <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>
80
+ <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>
81
+ <p></p><div class="right">(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
82
+ <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>
83
+ <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>
84
+ <p>Example Usage:</p>
85
+ <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><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)">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><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"> IgnorePacketProtocol </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)">IMAGE</span><span class="token plain"> </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>
86
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="option">OPTION<a href="#option" class="hash-link" aria-label="Direct link to OPTION" title="Direct link to OPTION">​</a></h3>
87
+ <p><strong>Set a parameter on an interface</strong></p>
88
+ <p>When an option is set the interface class calls the set_option method. Custom interfaces can override set_option to handle any additional options they want.</p>
89
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).</td><td>True</td></tr><tr><td>Parameters</td><td>Parameters to pass to the option</td><td>False</td></tr></tbody></table>
90
+ <p>Example Usage:</p>
91
+ <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><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>
92
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="secret">SECRET<a href="#secret" class="hash-link" aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
93
+ <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
94
+ <p>Defines a secret for this interface and optionally assigns its value to an option</p>
95
+ <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>
96
+ <p>Example Usage:</p>
97
+ <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>
98
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="env">ENV<a href="#env" class="hash-link" aria-label="Direct link to ENV" title="Direct link to ENV">​</a></h3>
99
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
100
+ <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>
101
+ <p>Example Usage:</p>
102
+ <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>
103
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="work_dir">WORK_DIR<a href="#work_dir" class="hash-link" aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR">​</a></h3>
104
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
105
+ <p>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</p>
106
+ <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>
107
+ <p>Example Usage:</p>
108
+ <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>
109
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="port">PORT<a href="#port" class="hash-link" aria-label="Direct link to PORT" title="Direct link to PORT">​</a></h3>
110
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
111
+ <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
112
+ <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>
113
+ <p>Example Usage:</p>
114
+ <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>
115
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd">CMD<a href="#cmd" class="hash-link" aria-label="Direct link to CMD" title="Direct link to CMD">​</a></h3>
116
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
117
+ <p>Command line to execute to run the microservice.</p>
118
+ <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>
119
+ <p>Example Usage:</p>
120
+ <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>
121
+ <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>
122
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
123
+ <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
124
+ <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>
125
+ <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>
126
+ <p></p><div class="right">(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
127
+ <p>Prefix of route to the microservice to expose externally with Traefik</p>
128
+ <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>
129
+ <p>Example Usage:</p>
130
+ <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>
131
+ <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>
132
+ <p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
133
+ <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>
134
+ <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>
135
+ <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
136
+ <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>
137
+ <p><strong>Defines a new target</strong></p>
138
+ <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>
139
+ <p>Example Usage:</p>
140
+ <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>
141
+ <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>
142
+ <p>The following keywords must follow a TARGET keyword.</p>
143
+ <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>
144
+ <p></p><div class="right">(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
145
+ <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>
146
+ <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>
147
+ <p><strong>Command binary logs can be cycled on a time interval.</strong></p>
148
+ <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>
149
+ <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>
150
+ <p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
151
+ <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>
152
+ <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>
153
+ <p><strong>How long to keep raw command logs in seconds.</strong></p>
154
+ <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>
155
+ <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>
156
+ <p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
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>
158
+ <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>
159
+ <p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
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>
161
+ <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>
162
+ <p><strong>How long to keep decom command logs in seconds.</strong></p>
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 decom command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
164
+ <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>
165
+ <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>
166
+ <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>
167
+ <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>
168
+ <p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
169
+ <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>
170
+ <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>
171
+ <p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
172
+ <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>
173
+ <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>
174
+ <p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
175
+ <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>
176
+ <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>
177
+ <p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
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>
179
+ <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>
180
+ <p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
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>
182
+ <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>
183
+ <p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
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 decom telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
185
+ <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>
186
+ <p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
187
+ <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>
188
+ <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>
189
+ <p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
190
+ <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>
191
+ <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>
192
+ <p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
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 reduced day telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
194
+ <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>
195
+ <p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
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 all regular telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
197
+ <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>
198
+ <p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
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 all reduced telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
200
+ <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>
201
+ <p><strong>Period at which to run the cleanup process.</strong></p>
202
+ <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>
203
+ <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>
204
+ <p><strong>Disables the data reduction microservice for the target</strong></p>
205
+ <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>
206
+ <p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
207
+ <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>
208
+ <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>
209
+ <p></p><div class="right">(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
210
+ <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>
211
+ <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>
212
+ <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>
213
+ <p></p><div class="right">(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
214
+ <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>
215
+ <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>
216
+ <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
217
+ <p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
218
+ <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>
219
+ <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>
220
+ <p><strong>Defines a new microservice</strong></p>
221
+ <p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
222
+ <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>
223
+ <p>Example Usage:</p>
224
+ <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>
225
+ <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>
226
+ <p>The following keywords must follow a MICROSERVICE keyword.</p>
227
+ <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>
228
+ <p><strong>Sets an environment variable in the microservice.</strong></p>
229
+ <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>
230
+ <p>Example Usage:</p>
231
+ <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>
232
+ <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>
233
+ <p><strong>Set the working directory</strong></p>
234
+ <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>
235
+ <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>
236
+ <p>Example Usage:</p>
237
+ <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>
238
+ <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>
239
+ <p></p><div class="right">(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
240
+ <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
241
+ <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>
242
+ <p>Example Usage:</p>
243
+ <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>
244
+ <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>
245
+ <p><strong>Associate a Redis topic</strong></p>
246
+ <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>
247
+ <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>
248
+ <p>Example Usage:</p>
249
+ <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>
250
+ <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>
251
+ <p><strong>Associate a OpenC3 target</strong></p>
252
+ <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>
253
+ <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>
254
+ <p>Example Usage:</p>
255
+ <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>
256
+ <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>
257
+ <p><strong>Command line to execute to run the microservice.</strong></p>
258
+ <p>Command line to execute to run the microservice.</p>
259
+ <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>
260
+ <p>Example Usage:</p>
261
+ <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>
262
+ <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>
263
+ <p><strong>Pass an option to the microservice</strong></p>
264
+ <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>
265
+ <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>
266
+ <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>
267
+ <p><strong>Docker Container</strong></p>
268
+ <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
269
+ <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>
270
+ <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>
271
+ <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
272
+ <p>Defines a secret for this microservice</p>
273
+ <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>
274
+ <p>Example Usage:</p>
275
+ <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>
276
+ <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>
277
+ <p></p><div class="right">(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
278
+ <p>Prefix of route to the microservice to expose externally with Traefik</p>
279
+ <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>
280
+ <p>Example Usage:</p>
281
+ <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>
282
+ <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>
283
+ <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
284
+ <p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
285
+ <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>
286
+ <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>
287
+ <p><strong>Define a tool</strong></p>
288
+ <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>
289
+ <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>
290
+ <p>Example Usage:</p>
291
+ <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>
292
+ <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>
293
+ <p>The following keywords must follow a TOOL keyword.</p>
294
+ <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>
295
+ <p><strong>Url used to access the tool</strong></p>
296
+ <p>The relative url used to access the tool. Defaults to &quot;/tools/ToolFolderName&quot;.</p>
297
+ <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>
298
+ <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>
299
+ <p><strong>Internal url to load a tool</strong></p>
300
+ <p>The url of the javascript file used to load the tool into single-SPA. Defaults to &quot;js/app.js&quot;.</p>
301
+ <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>
302
+ <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>
303
+ <p><strong>How to display the tool when navigated to</strong></p>
304
+ <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>
305
+ <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>
306
+ <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>
307
+ <p><strong>Set tool icon</strong></p>
308
+ <p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
309
+ <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>
310
+ <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>
311
+ <p><strong>Category for the tool</strong></p>
312
+ <p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
313
+ <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>
314
+ <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>
315
+ <p><strong>Show the tool or not</strong></p>
316
+ <p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
317
+ <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>
318
+ <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>
319
+ <p></p><div class="right">(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
320
+ <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>
321
+ <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>
322
+ <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>
323
+ <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
324
+ <p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
325
+ <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>
326
+ <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>
327
+ <p><strong>Define a custom widget</strong></p>
328
+ <p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
329
+ <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>
330
+ <p>Example Usage:</p>
331
+ <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>
332
+ <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>
333
+ <p>The following keywords must follow a WIDGET keyword.</p>
334
+ <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>
335
+ <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
336
+ <p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
337
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/format"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Targets</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
338
+ </body>
339
+ </html>