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/docs/docs/configuration/format.html DELETED
@@ -1,16 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-configuration/format" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v2.4.3">
6
- <title data-rh="true">File Format | 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/docs/docs/configuration/format"><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="File Format | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible."><meta data-rh="true" property="og:description" content="COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible."><link data-rh="true" rel="icon" href="/tools/docs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/docs/docs/configuration/format"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/docs/docs/configuration/format" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/docs/docs/configuration/format" hreflang="x-default"><link rel="stylesheet" href="/tools/docs/assets/css/styles.7bc79028.css">
7
- <link rel="preload" href="/tools/docs/assets/js/runtime~main.e3a6c705.js" as="script">
8
- <link rel="preload" href="/tools/docs/assets/js/main.b5a535c2.js" as="script">
9
- </head>
10
- <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
12
- <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/docs/"><div class="navbar__logo"><img src="/tools/docs/img/logo.svg" alt="OpenC3 Logo" class="themedImage_RWGG themedImage--light_riBm"><img src="/tools/docs/img/logo.svg" alt="OpenC3 Logo" class="themedImage_RWGG themedImage--dark_Dsi0"></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/docs/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="searchBox_xrOJ"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" 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 docsWrapper_BqXd"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docPage_pOTq"><aside class="theme-doc-sidebar-container docSidebarContainer_aIKW"><div class="sidebarViewport_DwR9"><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/docs/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/docs/docs/getting-started">Getting Started</a><button aria-label="Toggle the collapsible 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/docs/docs/configuration">Configuration</a><button aria-label="Toggle the collapsible 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 menu__link--active" aria-current="page" tabindex="0" href="/tools/docs/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" tabindex="0" href="/tools/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/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/docs/docs/tools">Tools</a><button aria-label="Toggle the collapsible 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/docs/docs/guides">Guides</a><button aria-label="Toggle the collapsible 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/docs/docs/development">Development</a><button aria-label="Toggle the collapsible 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/docs/docs/meta">Meta</a><button aria-label="Toggle the collapsible 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/docs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_fv3b"><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/docs/"><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/docs/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">File Format</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>File Format</h1></header><p>COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="keyword--parameters">Keyword / Parameters<a href="#keyword--parameters" class="hash-link" aria-label="Direct link to Keyword / Parameters" title="Direct link to Keyword / Parameters">​</a></h2><p>Each line of a COSMOS configuration file contains a single keyword followed by parameters. For example:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><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)">COLLECT</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Collect command&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><p>The keyword is <code>COMMAND</code> and the parameters are <code>TARGET</code>, <code>COLLECT</code>, <code>BIG_ENDIAN</code>, and <code>&quot;Collect command&quot;</code>. Keywords are parsed by COSMOS and parameters are checked for validity. Parameters can be required or optional although required parameters always come first. Some parameters have a limited set of valid values. For example, the <code>COMMAND</code> keyword above has the following documentation:</p><table><thead><tr><th>PARAMETER</th><th>DESCRIPTION</th><th>REQUIRED</th></tr></thead><tbody><tr><td>Target</td><td>Name of the target this command is associated with</td><td>True</td></tr><tr><td>Command</td><td>Name of this command. Also referred to as its mnemonic. Must be unique to commands to this target. Ideally will be as short and clear as possible.</td><td>True</td></tr><tr><td>Endianness</td><td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br><br>Valid Values: <code>BIG_ENDIAN, LITTLE_ENDIAN</code></td><td>True</td></tr><tr><td>Description</td><td>Description of this command which must be enclosed with quotes</td><td>False</td></tr></tbody></table><p>The Target and Command parameters can be any string and are required. The Endianness parameter is required and must be <code>BIG_ENDIAN</code> or <code>LITTLE_ENDIAN</code>. Other values will cause an error when parsed. The Description parameter must be enclosed in quotes and is optional. All the COSMOS configuration files document their keyword and parameters in this fashion. In addition, Example Usage is provided similar to the example given above.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="erb">ERB<a href="#erb" class="hash-link" aria-label="Direct link to ERB" title="Direct link to ERB">​</a></h2><p>ERB stands for Embedded Ruby. <a href="https://github.com/ruby/erb" target="_blank" rel="noopener noreferrer">ERB</a> is a templating system for Ruby which allows you to use Ruby logic and variables to generate text files. There are two basic forms of ERB:</p><div class="language-erb codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-erb codeBlock_TAPP thin-scrollbar"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">&lt;% Ruby code -- no output %&gt;</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">&lt;%= Ruby expression -- insert result %&gt;</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><p>In a COSMOS <a href="/tools/docs/docs/configuration/telemetry">Telemetry</a> configuration file we could write the following:</p><div class="language-erb codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-erb codeBlock_TAPP thin-scrollbar"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">&lt;% (1..5).each do |i| %&gt;</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> APPEND_ITEM VALUE&lt;%= i %&gt; 16 UINT &quot;Value &lt;%= i %&gt; setting&quot;</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">&lt;% end %&gt;</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><p>The first line is Ruby code which iterates from 1 up to and including 5 and places the value in the variable i. The code inside the block will be output to the file every time the iteration runs. The APPEND_ITEM line uses the value of i and directly outputs it to the file by using the <code>&lt;%=</code> syntax. The result of the parsing will look like the following:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE1</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value 1 setting&quot;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE2</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value 2 setting&quot;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE3</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value 3 setting&quot;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE4</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value 4 setting&quot;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE5</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value 5 setting&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><p>COSMOS uses ERB syntax extensively in a Plugin&#x27;s <a href="/tools/docs/docs/configuration/plugins#plugintxt-configuration-file">plugin.txt</a> configuration file.</p><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="render">render<a href="#render" class="hash-link" aria-label="Direct link to render" title="Direct link to render">​</a></h3><p>COSMOS provides a method used inside ERB called <code>render</code> which renders a configuration file into another configuration file. For example:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token operator" style="color:rgb(127, 219, 202)">%=</span><span class="token plain"> render </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;_ccsds_apid.txt&quot;</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token symbol">locals</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token symbol">apid</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">&gt;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECTS</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Number of collects&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">...</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><p>The render method takes a parameter which is the name of the configuration file to inject into the top level file. This file is required to start with underscore to avoid being processed as a regular configuration file. This file is called a partial since it&#x27;s part of a larger file. For example, <!-- -->_<!-- -->ccsds_apid.txt is defined as follows:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token operator" style="color:rgb(127, 219, 202)">%=</span><span class="token plain"> apid </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">&gt;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;CCSDS application process id&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><p>This would result in output as follows:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status&quot;</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)">APPEND_ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;CCSDS application process id&quot;</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)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COLLECTS</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Number of collects&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">...</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><p>Note the variable <code>apid</code> was set to 1 using the <code>locals:</code> syntax. This is a very powerful way to add common headers and footer to every packet definition. See the INST target&#x27;s cmd_tlm definitions in the <a href="https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm" target="_blank" rel="noopener noreferrer">Demo</a> for a more comprehensive example.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="line-continuation">Line Continuation<a href="#line-continuation" class="hash-link" aria-label="Direct link to Line Continuation" title="Direct link to Line Continuation">​</a></h2><p>COSMOS supports a line continuation character in configuration files. For a simple line continuation use the ampersand character: <code>&amp;</code>. For example:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 operator" style="color:rgb(127, 219, 202)">&amp;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status&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><p>This will strip the ampersand character and merge the two lines to result in:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status&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><p>Spaces around the second line are stripped so indentation does not matter.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="string-concatenation">String Concatenation<a href="#string-concatenation" class="hash-link" aria-label="Direct link to String Concatenation" title="Direct link to String Concatenation">​</a></h2><p>COSMOS supports two different string concatenation characters in configuration files. To concatenate strings with a newline use the plus character: <code>+</code>. For example:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status&quot;</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Additional description&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><p>The strings will be merged with a newline to result in:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Health and status\nAdditional description&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><p>To concatenate strings without a newline use the backslash character: <code>\</code>. For example:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&#x27;Health and status&#x27;</span><span class="token plain"> \</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;Additional description&#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><p>The strings will be merged without a newline to result in:</p><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"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</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)">HEALTH_STATUS</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 string-literal string" style="color:rgb(173, 219, 103)">&#x27;Health and statusAdditional description&#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><p>The string continuation characters work with both single or double quoted strings but note that both lines MUST use the same syntax. You can not concatenate a single quoted string with a double quoted string or vice versa. Also note the indentation of the second line does not matter as whitespace is stripped.</p></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/format.md" target="_blank" rel="noreferrer noopener" 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/docs/docs/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/docs/docs/configuration/plugins"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Plugins</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="#keyword--parameters" class="table-of-contents__link toc-highlight">Keyword / Parameters</a></li><li><a href="#erb" class="table-of-contents__link toc-highlight">ERB</a><ul><li><a href="#render" class="table-of-contents__link toc-highlight">render</a></li></ul></li><li><a href="#line-continuation" class="table-of-contents__link toc-highlight">Line Continuation</a></li><li><a href="#string-concatenation" class="table-of-contents__link toc-highlight">String Concatenation</a></li></ul></div></div></div></div></main></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/docs/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/docs/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>
13
- <script src="/tools/docs/assets/js/runtime~main.e3a6c705.js"></script>
14
- <script src="/tools/docs/assets/js/main.b5a535c2.js"></script>
15
- </body>
16
- </html>
data/tools/docs/docs/configuration/interfaces.html DELETED
@@ -1,16 +0,0 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-configuration/interfaces" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v2.4.3">
6
- <title data-rh="true">Interfaces | 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/docs/docs/configuration/interfaces"><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="Interfaces | OpenC3 Docs"><meta data-rh="true" name="description" content="Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file."><meta data-rh="true" property="og:description" content="Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file."><link data-rh="true" rel="icon" href="/tools/docs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/docs/docs/configuration/interfaces"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/docs/docs/configuration/interfaces" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/docs/docs/configuration/interfaces" hreflang="x-default"><link rel="stylesheet" href="/tools/docs/assets/css/styles.7bc79028.css">
7
- <link rel="preload" href="/tools/docs/assets/js/runtime~main.e3a6c705.js" as="script">
8
- <link rel="preload" href="/tools/docs/assets/js/main.b5a535c2.js" as="script">
9
- </head>
10
- <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
12
- <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/docs/"><div class="navbar__logo"><img src="/tools/docs/img/logo.svg" alt="OpenC3 Logo" class="themedImage_RWGG themedImage--light_riBm"><img src="/tools/docs/img/logo.svg" alt="OpenC3 Logo" class="themedImage_RWGG themedImage--dark_Dsi0"></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/docs/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="searchBox_xrOJ"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" 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 docsWrapper_BqXd"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docPage_pOTq"><aside class="theme-doc-sidebar-container docSidebarContainer_aIKW"><div class="sidebarViewport_DwR9"><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/docs/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/docs/docs/getting-started">Getting Started</a><button aria-label="Toggle the collapsible 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/docs/docs/configuration">Configuration</a><button aria-label="Toggle the collapsible 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/docs/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" tabindex="0" href="/tools/docs/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/docs/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/docs/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/docs/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 menu__link--active" aria-current="page" tabindex="0" href="/tools/docs/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/docs/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/docs/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/docs/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/docs/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/docs/docs/tools">Tools</a><button aria-label="Toggle the collapsible 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/docs/docs/guides">Guides</a><button aria-label="Toggle the collapsible 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/docs/docs/development">Development</a><button aria-label="Toggle the collapsible 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/docs/docs/meta">Meta</a><button aria-label="Toggle the collapsible 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/docs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_fv3b"><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/docs/"><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/docs/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">Interfaces</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>Interfaces</h1></header><p>Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level <a href="/tools/docs/docs/configuration/plugins#interface-1">INTERFACE</a> keyword in the plugin.txt file.</p><p>Interface classes provide the code that COSMOS uses to receive real-time telemetry from targets and to send commands to targets. The interface that a target uses could be anything (TCP/IP, serial, GPIB, Firewire, etc.), therefore it is important that this is a customizable portion of any reusable Command and Telemetry System. Fortunately the most common form of interfaces are over TCP/IP sockets, and COSMOS provides interface solutions for these. This guide will discuss how to use these interface classes, and how to create your own. Note that in most cases you can extend interfaces with <a href="/tools/docs/docs/configuration/protocols">Protocols</a> rather than implementing a new interface.</p><div class="theme-admonition theme-admonition-info alert alert--info admonition_qNG0"><div class="admonitionHeading_l909"><span class="admonitionIcon_UNbs"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Interface and Routers Are Very Similar</div><div class="admonitionContent_oUmQ"><p>Note that Interfaces and Routers are very similar and share the same configuration parameters. Routers are simply Interfaces which route an existing Interface&#x27;s telemetry data out to the connected target and routes the connected target&#x27;s commands back to the original Interface&#x27;s target.</p></div></div><p>Interfaces have the following methods that must be implemented:</p><ol><li><strong>connect</strong> - Open the socket or port or somehow establish the connection to the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation.</li><li><strong>connected?</strong> - Return true or false depending on the connection state. Note: This method should return immediately.</li><li><strong>disconnect</strong> - Close the socket or port of somehow disconnect from the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation.</li><li><strong>read_interface</strong> - Lowest level read of data on the interface. Note: This method should block until data is available or the interface disconnects. On a clean disconnect it should return nil.</li><li><strong>write_interface</strong> - Lowest level write of data on the interface. Note: This method may not block indefinitely.</li></ol><p>Interfaces also have the following methods that exist and have default implementations. They can be overridden if necessary but be sure to call super() to allow the default implementation to be executed.</p><ol><li><strong>read_interface_base</strong> - This method should always be called from read_interface(). It updates interface specific variables that are displayed by CmdTLmServer including the bytes read count, the most recent raw data read, and it handles raw logging if enabled.</li><li><strong>write_interface_base</strong> - This method should always be called from write_interface(). It updates interface specific variables that are displayed by CmdTLmServer including the bytes written count, the most recent raw data written, and it handles raw logging if enabled.</li><li><strong>read</strong> - Read the next packet from the interface. COSMOS implements this method to allow the Protocol system to operate on the data and the packet before it is returned.</li><li><strong>write</strong> - Send a packet to the interface. COSMOS implements this method to allow the Protocol system to operate on the packet and the data before it is sent.</li><li><strong>write_raw</strong> - Send a raw binary string of data to the target. COSMOS implements this method by basically calling write_interface with the raw data.</li></ol><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_qNG0"><div class="admonitionHeading_l909"><span class="admonitionIcon_UNbs"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Naming Conventions</div><div class="admonitionContent_oUmQ"><p>When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described below. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive &quot;class not found&quot; errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.</p></div></div><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="provided-interfaces">Provided Interfaces<a href="#provided-interfaces" class="hash-link" aria-label="Direct link to Provided Interfaces" title="Direct link to Provided Interfaces">​</a></h2><p>COSMOS provides the following interfaces for use: TCPIP Client, TCPIP Server, UDP, and Serial. The interface to use is defined by the <a href="/tools/docs/docs/configuration/plugins#interface">INTERFACE</a> and <a href="/tools/docs/docs/configuration/plugins#router">ROUTER</a> keywords.</p><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tcpip-client-interface">TCPIP Client Interface<a href="#tcpip-client-interface" class="hash-link" aria-label="Direct link to TCPIP Client Interface" title="Direct link to TCPIP Client Interface">​</a></h3><p>The TCPIP client interface connects to a TCPIP socket to send commands and receive telemetry. This interface is used for targets which open a socket and wait for a connection. This is the most common type of interface.</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Host</td><td>Machine name to connect to</td><td>Yes</td></tr><tr><td>Write Port</td><td>Port to write commands to (can be the same as read port). Pass nil to make the interface read only.</td><td>Yes</td></tr><tr><td>Read Port</td><td>Port to read telemetry from (can be the same as write port). Pass nil to make the interface write only.</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass &#x27;nil&#x27; to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table><p>plugin.txt Examples:</p><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"><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)">INTERFACE_NAME</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)">LENGTH</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)">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)">INTERFACE_NAME</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)">8080</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><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)">0xDEADBEEF</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)">INTERFACE_NAME</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)">8080</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)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">INTERFACE_NAME</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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">0xF005BA11</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)">INTERFACE_NAME</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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</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)">INTERFACE_NAME</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)">8080</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)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</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)">INTERFACE_NAME</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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</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><p>See <a href="/tools/docs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/docs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword.</p><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tcpip-server-interface">TCPIP Server Interface<a href="#tcpip-server-interface" class="hash-link" aria-label="Direct link to TCPIP Server Interface" title="Direct link to TCPIP Server Interface">​</a></h3><p>The TCPIP server interface creates a TCPIP server which listens for incoming connections and dynamically creates sockets which communicate with the target. This interface is used for targets which open a socket and try to connect to a server.</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Write Port</td><td>Port to write commands to (can be the same as read port)</td><td>Yes</td></tr><tr><td>Read Port</td><td>Port to read telemetry from (can be the same as write port)</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass &#x27;nil&#x27; to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table><p>plugin.txt Examples:</p><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"><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)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">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)">LENGTH</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)">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)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </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)">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><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)">0xDEADBEEF</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)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </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)">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)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </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)">10.0</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 constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">0xF005BA11</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)">INTERFACE_NAME</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 </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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</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)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </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)">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)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</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)">INTERFACE_NAME</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 </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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</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><p>See <a href="/tools/docs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/docs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword. Note, TcpipServerInterface processes the <a href="/tools/docs/docs/configuration/plugins#option">OPTION</a> modifier.</p><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="udp-interface">UDP Interface<a href="#udp-interface" class="hash-link" aria-label="Direct link to UDP Interface" title="Direct link to UDP Interface">​</a></h3><p>The UDP interface uses UDP packets to send and receive telemetry from the target.</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td>Host</td><td>Host name or IP address of the machine to send and receive data with</td><td>Yes</td><td></td></tr><tr><td>Write Dest Port</td><td>Port on the remote machine to send commands to</td><td>Yes</td><td></td></tr><tr><td>Read Port</td><td>Port on the remote machine to read telemetry from</td><td>Yes</td><td></td></tr><tr><td>Write Source Port</td><td>Port on the local machine to send commands from</td><td>No</td><td>nil (socket is not bound to an outgoing port)</td></tr><tr><td>Interface Address</td><td>If the remote machine supports multicast the interface address is used to configure the outgoing multicast address</td><td>No</td><td>nil (not used)</td></tr><tr><td>TTL</td><td>Time to Live. The number of intermediate routers allowed before dropping the packet.</td><td>No</td><td>128 (Windows)</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>No</td><td>10.0</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read</td><td>No</td><td>nil (block on read)</td></tr></tbody></table><p>plugin.txt Example:</p><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"><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)">INTERFACE_NAME</span><span class="token plain"> udp_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)">8082</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 number" style="color:rgb(247, 140, 108)">128</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><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><p>See <a href="/tools/docs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/docs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword.</p><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="serial-interface">Serial Interface<a href="#serial-interface" class="hash-link" aria-label="Direct link to Serial Interface" title="Direct link to Serial Interface">​</a></h3><p>The serial interface connects to a target over a serial port. COSMOS provides drivers for both Windows and POSIX drivers for UNIX based systems.</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Write Port</td><td>Name of the serial port to write, e.g. &#x27;COM1&#x27; or &#x27;/dev/ttyS0&#x27;. Pass &#x27;nil&#x27; to disable writing.</td><td>Yes</td></tr><tr><td>Read Port</td><td>Name of the serial port to read, e.g. &#x27;COM1&#x27; or &#x27;/dev/ttyS0&#x27;. Pass &#x27;nil&#x27; to disable reading.</td><td>Yes</td></tr><tr><td>Baud Rate</td><td>Baud rate to read and write</td><td>Yes</td></tr><tr><td>Parity</td><td>Serial port parity. Must be &#x27;NONE&#x27;, &#x27;EVEN&#x27;, or &#x27;ODD&#x27;.</td><td>Yes</td></tr><tr><td>Stop Bits</td><td>Number of stop bits, e.g. 1.</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass &#x27;nil&#x27; to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table><p>plugin.txt Examples:</p><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"><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)">INTERFACE_NAME</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)">9600</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><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</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)">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)">INTERFACE_NAME</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 operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token number" style="color:rgb(247, 140, 108)">38400</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ODD</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><span class="token constant" style="color:rgb(130, 170, 255)">BURST</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)">0xDEADBEEF</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)">INTERFACE_NAME</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)">COM2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">19200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EVEN</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><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">INTERFACE_NAME</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)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">0xF005BA11</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)">INTERFACE_NAME</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)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</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)">INTERFACE_NAME</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 operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token number" style="color:rgb(247, 140, 108)">57600</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><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</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)">INTERFACE_NAME</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)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</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><p>See <a href="/tools/docs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/docs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword. Note, SerialInterface processes the <a href="/tools/docs/docs/configuration/plugins#option">OPTION</a> modifier.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="streams">Streams<a href="#streams" class="hash-link" aria-label="Direct link to Streams" title="Direct link to Streams">​</a></h2><p>Streams are low level classes that implement read, read_nonblock, write, connect, connected? and disconnect methods. The build-in Stream classes are SerialStream, TcpipSocketStream and TcpipClientStream and they are automatically used when creating a Serial Interface, TCP/IP Server Interface, or TCP/IP Client Interface.</p><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="protocols">Protocols<a href="#protocols" class="hash-link" aria-label="Direct link to Protocols" title="Direct link to Protocols">​</a></h2><p>Protocols define the behaviour of an Interface, including differentiating packet boundaries and modifying data as necessary. COSMOS defines the following built-in protocols which can be used with the above interfaces:</p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><a href="/tools/docs/docs/configuration/protocols#burst-protocol">Burst</a></td><td>Reads as much data as possible from the interface</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#fixed-protocol">Fixed</a></td><td>Processes fixed length packets with a known ID position</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#length-protocol">Length</a></td><td>Processes a length field at a fixed location and then reads the remainder of the data</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#terminated-protocol">Terminated</a></td><td>Delineates packets uses termination characters at the end of each packet</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#template-protocol">Template</a></td><td>Processes text based command / response data such as SCPI interfaces</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#preidentified-protocol">Preidentified</a></td><td>Internal COSMOS protocol used by COSMOS tools</td></tr></tbody></table><p>These protocols are declared directly after the interface:</p><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"><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)">INTERFACE_NAME</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)">8080</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><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)">0xDEADBEEF</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)">INTERFACE_NAME</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)">8080</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)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">INTERFACE_NAME</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)">LENGTH</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)">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 constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</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)">0xF005BA11</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)">INTERFACE_NAME</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)">8080</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 number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</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)">INTERFACE_NAME</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)">8080</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)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</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><p>COSMOS also defines the following helper protocols:</p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><a href="/tools/docs/docs/configuration/protocols#crc-protocol">CRC</a></td><td>Adds CRCs to outgoing packets and verifies CRCs on incoming packets</td></tr><tr><td><a href="/tools/docs/docs/configuration/protocols#ignore-packet-protocol">Ignore</a></td><td>Ignores the specified packet by dropping it</td></tr></tbody></table><p>These protocols are declared after the INTERFACE:</p><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"><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)">INTERFACE_NAME</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)">8080</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><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)">0xDEADBEEF</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)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TGT</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)">WRITE</span><span class="token plain"> CrcProtocol </span><span class="token constant" style="color:rgb(130, 170, 255)">CRC</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># See the documentation for parameters</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><p>Note the first parameter after the PROTOCOL keyword is how to apply the protocol: READ, WRITE, or READ_WRITE. Read applies the protocol on incoming packets (telemetry) and write on outgoing packets (commands). The next parameter is the protocol filename or class name. All other parameters are protocol specific.</p><p>In addition, you can define your own protocols which are declared like the COSMOS helper protocols after your interface. See the <a href="/tools/docs/docs/configuration/protocols#custom-protocols">Custom Protocols</a> documentation for more information.</p><div class="theme-admonition theme-admonition-info alert alert--info admonition_qNG0"><div class="admonitionHeading_l909"><span class="admonitionIcon_UNbs"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Protocol Run Order</div><div class="admonitionContent_oUmQ"><p>Read protocols execute in the order specified (First specified runs first). Write protocols execute in the reverse order (Last specified executes first).</p></div></div></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/interfaces.md" target="_blank" rel="noreferrer noopener" 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/docs/docs/configuration/telemetry"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Telemetry</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/docs/docs/configuration/protocols"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Protocols</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="#provided-interfaces" class="table-of-contents__link toc-highlight">Provided Interfaces</a><ul><li><a href="#tcpip-client-interface" class="table-of-contents__link toc-highlight">TCPIP Client Interface</a></li><li><a href="#tcpip-server-interface" class="table-of-contents__link toc-highlight">TCPIP Server Interface</a></li><li><a href="#udp-interface" class="table-of-contents__link toc-highlight">UDP Interface</a></li><li><a href="#serial-interface" class="table-of-contents__link toc-highlight">Serial Interface</a></li></ul></li><li><a href="#streams" class="table-of-contents__link toc-highlight">Streams</a></li><li><a href="#protocols" class="table-of-contents__link toc-highlight">Protocols</a></li></ul></div></div></div></div></main></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/docs/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/docs/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>
13
- <script src="/tools/docs/assets/js/runtime~main.e3a6c705.js"></script>
14
- <script src="/tools/docs/assets/js/main.b5a535c2.js"></script>
15
- </body>
16
- </html>