openc3-cosmos-tool-docs 5.12.0 → 5.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (624) hide show
  1. checksums.yaml +4 -4
  2. data/plugin.txt +3 -3
  3. data/tools/staticdocs/404.html +13 -0
  4. data/tools/staticdocs/assets/css/styles.6e885bef.css +1 -0
  5. data/tools/staticdocs/assets/js/019369f3.d8613c30.js +1 -0
  6. data/tools/staticdocs/assets/js/058ffc22.acfac831.js +1 -0
  7. data/tools/staticdocs/assets/js/0686a885.4e302d8a.js +1 -0
  8. data/tools/staticdocs/assets/js/07876b9c.990c8af0.js +1 -0
  9. data/tools/staticdocs/assets/js/078dbab0.d34d0a8f.js +1 -0
  10. data/tools/staticdocs/assets/js/0f5d161c.d985bc97.js +1 -0
  11. data/tools/staticdocs/assets/js/0ff569c9.e271df4e.js +1 -0
  12. data/tools/staticdocs/assets/js/103cc3be.4cf4eeb0.js +1 -0
  13. data/tools/staticdocs/assets/js/12.ef103c80.js +1 -0
  14. data/tools/staticdocs/assets/js/13196248.51e9b91e.js +1 -0
  15. data/tools/staticdocs/assets/js/13c1b4e4.82c72cb7.js +1 -0
  16. data/tools/staticdocs/assets/js/1b2b4b61.b662e271.js +1 -0
  17. data/tools/staticdocs/assets/js/2047b354.fd40457e.js +1 -0
  18. data/tools/staticdocs/assets/js/22b3ac48.10ffd4c3.js +1 -0
  19. data/tools/staticdocs/assets/js/2624.ae6ba6f0.js +1 -0
  20. data/tools/staticdocs/assets/js/26b8abb2.a77dc1e7.js +1 -0
  21. data/tools/staticdocs/assets/js/3dd7ef3b.e063c83a.js +1 -0
  22. data/tools/staticdocs/assets/js/3df159b4.7047e215.js +1 -0
  23. data/tools/staticdocs/assets/js/40365d27.cfe2d836.js +1 -0
  24. data/tools/staticdocs/assets/js/411898ad.fb3b44cb.js +1 -0
  25. data/tools/staticdocs/assets/js/42170351.cee0ce87.js +1 -0
  26. data/tools/staticdocs/assets/js/43652efd.a68af7c2.js +1 -0
  27. data/tools/staticdocs/assets/js/4657.9492019f.js +2 -0
  28. data/tools/staticdocs/assets/js/53ca7c5b.5ba66d69.js +1 -0
  29. data/tools/staticdocs/assets/js/54d0d530.ae86bb53.js +1 -0
  30. data/tools/staticdocs/assets/js/55cdbca5.9562da85.js +1 -0
  31. data/tools/staticdocs/assets/js/5bc719f6.3f10a4f9.js +1 -0
  32. data/tools/staticdocs/assets/js/5c6ce5ec.3cb1b75a.js +1 -0
  33. data/tools/staticdocs/assets/js/5e3ed378.98a98907.js +1 -0
  34. data/tools/staticdocs/assets/js/5fe211ef.943a1325.js +1 -0
  35. data/tools/staticdocs/assets/js/64630c4f.d3aaa17e.js +1 -0
  36. data/tools/staticdocs/assets/js/6831b732.677fead8.js +1 -0
  37. data/tools/staticdocs/assets/js/696b4199.68411c90.js +1 -0
  38. data/tools/staticdocs/assets/js/6b210247.f17d074a.js +1 -0
  39. data/tools/staticdocs/assets/js/6b65133b.1691ed32.js +1 -0
  40. data/tools/staticdocs/assets/js/6f92e431.0e99b0f7.js +1 -0
  41. data/tools/staticdocs/assets/js/7158.db39a041.js +1 -0
  42. data/tools/staticdocs/assets/js/72c6d8a8.895d48ed.js +1 -0
  43. data/tools/staticdocs/assets/js/75373ac0.f2ff00fb.js +1 -0
  44. data/tools/staticdocs/assets/js/75e64983.a5199202.js +1 -0
  45. data/tools/staticdocs/assets/js/867640d5.52676c0c.js +1 -0
  46. data/tools/staticdocs/assets/js/89e76475.da0a4de8.js +1 -0
  47. data/tools/staticdocs/assets/js/8f7843ee.5069508d.js +1 -0
  48. data/tools/staticdocs/assets/js/9424f0b3.d0685f0f.js +1 -0
  49. data/tools/staticdocs/assets/js/97535711.7354a61a.js +1 -0
  50. data/tools/staticdocs/assets/js/99581c43.d6c28a4e.js +1 -0
  51. data/tools/staticdocs/assets/js/99b59eea.56ab3bff.js +1 -0
  52. data/tools/staticdocs/assets/js/9d6e81d0.9a3ba2db.js +1 -0
  53. data/tools/staticdocs/assets/js/9fb6059a.709498de.js +1 -0
  54. data/tools/staticdocs/assets/js/a507c363.b04cc959.js +1 -0
  55. data/tools/staticdocs/assets/js/a677c089.759b7b09.js +1 -0
  56. data/tools/staticdocs/assets/js/a9987364.e1bf97fd.js +1 -0
  57. data/tools/staticdocs/assets/js/aa6b6c1b.eb0299eb.js +1 -0
  58. data/tools/staticdocs/assets/js/b4596165.d2ef4105.js +1 -0
  59. data/tools/staticdocs/assets/js/b6d70f94.67e3cf1e.js +1 -0
  60. data/tools/staticdocs/assets/js/b9f60ba6.4f87cb90.js +1 -0
  61. data/tools/staticdocs/assets/js/bd0034eb.caedd00a.js +1 -0
  62. data/tools/staticdocs/assets/js/c24eae19.541e6a95.js +1 -0
  63. data/tools/staticdocs/assets/js/cb8c3f08.9ca026be.js +1 -0
  64. data/tools/staticdocs/assets/js/cd879be4.4b9bf792.js +1 -0
  65. data/tools/staticdocs/assets/js/d1b923aa.2c753a51.js +1 -0
  66. data/tools/staticdocs/assets/js/d1bfc316.f860e15e.js +1 -0
  67. data/tools/staticdocs/assets/js/d24bf9b6.a8d698fc.js +1 -0
  68. data/tools/staticdocs/assets/js/d57a4b5d.743b976b.js +1 -0
  69. data/tools/staticdocs/assets/js/d5d77c37.c1e1579f.js +1 -0
  70. data/tools/staticdocs/assets/js/d8ca4191.abd56e6c.js +1 -0
  71. data/tools/staticdocs/assets/js/d9b92eba.cd5125b1.js +1 -0
  72. data/tools/staticdocs/assets/js/db8fa1d0.c1a3930b.js +1 -0
  73. data/tools/staticdocs/assets/js/dc5f7beb.87e69867.js +1 -0
  74. data/tools/staticdocs/assets/js/e501b0d1.64985b23.js +1 -0
  75. data/tools/staticdocs/assets/js/ebec1ccb.15788749.js +1 -0
  76. data/tools/staticdocs/assets/js/f15615f1.0d1e925a.js +1 -0
  77. data/tools/staticdocs/assets/js/fd886806.5a283ff8.js +1 -0
  78. data/tools/staticdocs/assets/js/main.1b3209ca.js +2 -0
  79. data/tools/{docs/assets/js/main.b5a535c2.js.LICENSE.txt → staticdocs/assets/js/main.1b3209ca.js.LICENSE.txt} +24 -23
  80. data/tools/staticdocs/assets/js/runtime~main.6ca622b3.js +1 -0
  81. data/tools/staticdocs/docs/configuration/command.html +252 -0
  82. data/tools/staticdocs/docs/configuration/format.html +51 -0
  83. data/tools/staticdocs/docs/configuration/interfaces.html +72 -0
  84. data/tools/staticdocs/docs/configuration/plugins.html +339 -0
  85. data/tools/staticdocs/docs/configuration/protocols.html +118 -0
  86. data/tools/staticdocs/docs/configuration/ssl-tls.html +97 -0
  87. data/tools/staticdocs/docs/configuration/table.html +178 -0
  88. data/tools/staticdocs/docs/configuration/target.html +60 -0
  89. data/tools/staticdocs/docs/configuration/telemetry-screens.html +526 -0
  90. data/tools/staticdocs/docs/configuration/telemetry.html +198 -0
  91. data/tools/staticdocs/docs/configuration.html +13 -0
  92. data/tools/staticdocs/docs/development/curl.html +30 -0
  93. data/tools/staticdocs/docs/development/developing.html +111 -0
  94. data/tools/staticdocs/docs/development/host-install.html +38 -0
  95. data/tools/staticdocs/docs/development/json-api.html +59 -0
  96. data/tools/staticdocs/docs/development/log-structure.html +38 -0
  97. data/tools/staticdocs/docs/development/roadmap.html +15 -0
  98. data/tools/staticdocs/docs/development/streaming-api.html +37 -0
  99. data/tools/staticdocs/docs/development/testing.html +60 -0
  100. data/tools/staticdocs/docs/development.html +13 -0
  101. data/tools/staticdocs/docs/getting-started/gettingstarted.html +128 -0
  102. data/tools/staticdocs/docs/getting-started/installation.html +66 -0
  103. data/tools/staticdocs/docs/getting-started/key_concepts.html +45 -0
  104. data/tools/staticdocs/docs/getting-started/podman.html +95 -0
  105. data/tools/staticdocs/docs/getting-started/requirements.html +84 -0
  106. data/tools/staticdocs/docs/getting-started/upgrading.html +47 -0
  107. data/tools/staticdocs/docs/getting-started.html +13 -0
  108. data/tools/staticdocs/docs/guides/bridges.html +63 -0
  109. data/tools/staticdocs/docs/guides/cfs.html +115 -0
  110. data/tools/staticdocs/docs/guides/custom-widgets.html +30 -0
  111. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +31 -0
  112. data/tools/staticdocs/docs/guides/local-mode.html +37 -0
  113. data/tools/staticdocs/docs/guides/logging.html +31 -0
  114. data/tools/staticdocs/docs/guides/monitoring.html +52 -0
  115. data/tools/staticdocs/docs/guides/performance.html +59 -0
  116. data/tools/staticdocs/docs/guides/raspberrypi.html +81 -0
  117. data/tools/staticdocs/docs/guides/script-writing.html +260 -0
  118. data/tools/staticdocs/docs/guides/scripting-api.html +1073 -0
  119. data/tools/staticdocs/docs/guides.html +13 -0
  120. data/tools/staticdocs/docs/meta/contributing.html +52 -0
  121. data/tools/staticdocs/docs/meta/philosophy.html +39 -0
  122. data/tools/staticdocs/docs/meta/xtce.html +110 -0
  123. data/tools/staticdocs/docs/meta.html +13 -0
  124. data/tools/staticdocs/docs/privacy.html +68 -0
  125. data/tools/staticdocs/docs/tools/autonomic.html +28 -0
  126. data/tools/staticdocs/docs/tools/bucket-explorer.html +23 -0
  127. data/tools/staticdocs/docs/tools/calendar.html +47 -0
  128. data/tools/staticdocs/docs/tools/cmd-sender.html +39 -0
  129. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +45 -0
  130. data/tools/staticdocs/docs/tools/data-extractor.html +73 -0
  131. data/tools/staticdocs/docs/tools/data-viewer.html +32 -0
  132. data/tools/staticdocs/docs/tools/handbooks.html +16 -0
  133. data/tools/staticdocs/docs/tools/limits-monitor.html +30 -0
  134. data/tools/staticdocs/docs/tools/packet-viewer.html +37 -0
  135. data/tools/staticdocs/docs/tools/script-runner.html +91 -0
  136. data/tools/staticdocs/docs/tools/table-manager.html +34 -0
  137. data/tools/staticdocs/docs/tools/tlm-grapher.html +61 -0
  138. data/tools/staticdocs/docs/tools/tlm-viewer.html +45 -0
  139. data/tools/staticdocs/docs/tools.html +13 -0
  140. data/tools/staticdocs/docs/v5/bridges/index.html +11 -0
  141. data/tools/staticdocs/docs/v5/bucket-explorer/index.html +11 -0
  142. data/tools/staticdocs/docs/v5/calendar/index.html +11 -0
  143. data/tools/staticdocs/docs/v5/cfs/index.html +11 -0
  144. data/tools/staticdocs/docs/v5/cmd-sender/index.html +11 -0
  145. data/tools/staticdocs/docs/v5/cmd-tlm-server/index.html +11 -0
  146. data/tools/staticdocs/docs/v5/command/index.html +11 -0
  147. data/tools/staticdocs/docs/v5/contributing/index.html +11 -0
  148. data/tools/staticdocs/docs/v5/custom-widgets/index.html +11 -0
  149. data/tools/staticdocs/docs/v5/data-extractor/index.html +11 -0
  150. data/tools/staticdocs/docs/v5/data-viewer/index.html +11 -0
  151. data/tools/staticdocs/docs/v5/development/index.html +11 -0
  152. data/tools/staticdocs/docs/v5/format/index.html +11 -0
  153. data/tools/staticdocs/docs/v5/gettingstarted/index.html +11 -0
  154. data/tools/staticdocs/docs/v5/handbooks/index.html +11 -0
  155. data/tools/staticdocs/docs/v5/host-install/index.html +11 -0
  156. data/tools/staticdocs/docs/v5/index.html +11 -0
  157. data/tools/staticdocs/docs/v5/installation/index.html +11 -0
  158. data/tools/staticdocs/docs/v5/interfaces/index.html +11 -0
  159. data/tools/staticdocs/docs/v5/json-api/index.html +11 -0
  160. data/tools/staticdocs/docs/v5/limits-monitor/index.html +11 -0
  161. data/tools/staticdocs/docs/v5/little-endian-bitfields/index.html +11 -0
  162. data/tools/staticdocs/docs/v5/local-mode/index.html +11 -0
  163. data/tools/staticdocs/docs/v5/log-structure/index.html +11 -0
  164. data/tools/staticdocs/docs/v5/logging/index.html +11 -0
  165. data/tools/staticdocs/docs/v5/monitoring/index.html +11 -0
  166. data/tools/staticdocs/docs/v5/packet-viewer/index.html +11 -0
  167. data/tools/staticdocs/docs/v5/performance/index.html +11 -0
  168. data/tools/staticdocs/docs/v5/philosophy/index.html +11 -0
  169. data/tools/staticdocs/docs/v5/plugins/index.html +11 -0
  170. data/tools/staticdocs/docs/v5/podman/index.html +11 -0
  171. data/tools/staticdocs/docs/v5/protocols/index.html +11 -0
  172. data/tools/staticdocs/docs/v5/raspberrypi/index.html +11 -0
  173. data/tools/staticdocs/docs/v5/requirements/index.html +11 -0
  174. data/tools/staticdocs/docs/v5/roadmap/index.html +11 -0
  175. data/tools/staticdocs/docs/v5/script-runner/index.html +11 -0
  176. data/tools/staticdocs/docs/v5/script-writing/index.html +11 -0
  177. data/tools/staticdocs/docs/v5/scripting-api/index.html +11 -0
  178. data/tools/staticdocs/docs/v5/ssl-tls/index.html +11 -0
  179. data/tools/staticdocs/docs/v5/streaming-api/index.html +11 -0
  180. data/tools/staticdocs/docs/v5/table/index.html +11 -0
  181. data/tools/staticdocs/docs/v5/table-manager/index.html +11 -0
  182. data/tools/staticdocs/docs/v5/target/index.html +11 -0
  183. data/tools/staticdocs/docs/v5/telemetry/index.html +11 -0
  184. data/tools/staticdocs/docs/v5/telemetry-screens/index.html +11 -0
  185. data/tools/staticdocs/docs/v5/testing/index.html +11 -0
  186. data/tools/staticdocs/docs/v5/tlm-grapher/index.html +11 -0
  187. data/tools/staticdocs/docs/v5/tlm-viewer/index.html +11 -0
  188. data/tools/staticdocs/docs/v5/tools/index.html +11 -0
  189. data/tools/staticdocs/docs/v5/upgrading/index.html +11 -0
  190. data/tools/staticdocs/docs/v5/xtce/index.html +11 -0
  191. data/tools/staticdocs/docs.html +34 -0
  192. data/tools/staticdocs/index.html +13 -0
  193. data/tools/staticdocs/lunr-index-1702922896263.json +1 -0
  194. data/tools/staticdocs/lunr-index.json +1 -0
  195. data/tools/staticdocs/markdown-page.html +14 -0
  196. data/tools/staticdocs/search-doc-1702922896263.json +1 -0
  197. data/tools/staticdocs/search-doc.json +1 -0
  198. data/tools/staticdocs/sitemap.xml +1 -0
  199. metadata +432 -428
  200. data/tools/docs/404.html +0 -16
  201. data/tools/docs/assets/css/styles.7bc79028.css +0 -1
  202. data/tools/docs/assets/js/019369f3.bb600de8.js +0 -1
  203. data/tools/docs/assets/js/058ffc22.ce27f074.js +0 -1
  204. data/tools/docs/assets/js/0686a885.5fe3bfd4.js +0 -1
  205. data/tools/docs/assets/js/078dbab0.0a98e0c9.js +0 -1
  206. data/tools/docs/assets/js/0f5d161c.3a7b00e4.js +0 -1
  207. data/tools/docs/assets/js/0ff569c9.930bab08.js +0 -1
  208. data/tools/docs/assets/js/103cc3be.451dd416.js +0 -1
  209. data/tools/docs/assets/js/13196248.1be5ac81.js +0 -1
  210. data/tools/docs/assets/js/13c1b4e4.ad24c4f6.js +0 -1
  211. data/tools/docs/assets/js/15a39a64.4138456c.js +0 -1
  212. data/tools/docs/assets/js/2029.9e268a82.js +0 -1
  213. data/tools/docs/assets/js/2047b354.7995865f.js +0 -1
  214. data/tools/docs/assets/js/22b3ac48.73a6c979.js +0 -1
  215. data/tools/docs/assets/js/2846.a87f3fc4.js +0 -1
  216. data/tools/docs/assets/js/3477.783e2e37.js +0 -2
  217. data/tools/docs/assets/js/3dd7ef3b.8f77876c.js +0 -1
  218. data/tools/docs/assets/js/3df159b4.dded3e78.js +0 -1
  219. data/tools/docs/assets/js/40365d27.9322abd8.js +0 -1
  220. data/tools/docs/assets/js/411898ad.a1d949a2.js +0 -1
  221. data/tools/docs/assets/js/42170351.46c774f8.js +0 -1
  222. data/tools/docs/assets/js/43652efd.cbac4bc0.js +0 -1
  223. data/tools/docs/assets/js/5109.6a372217.js +0 -1
  224. data/tools/docs/assets/js/54d0d530.e9c8193b.js +0 -1
  225. data/tools/docs/assets/js/5bc719f6.fce76244.js +0 -1
  226. data/tools/docs/assets/js/5c6ce5ec.f909714f.js +0 -1
  227. data/tools/docs/assets/js/5e3ed378.cdfe0362.js +0 -1
  228. data/tools/docs/assets/js/5fe211ef.809c3f96.js +0 -1
  229. data/tools/docs/assets/js/6831b732.735c11e9.js +0 -1
  230. data/tools/docs/assets/js/696b4199.ff9185d0.js +0 -1
  231. data/tools/docs/assets/js/6b210247.248680ef.js +0 -1
  232. data/tools/docs/assets/js/6b65133b.2144fb1b.js +0 -1
  233. data/tools/docs/assets/js/6f92e431.608f28e7.js +0 -1
  234. data/tools/docs/assets/js/72c6d8a8.062b7650.js +0 -1
  235. data/tools/docs/assets/js/75e64983.d42f03f8.js +0 -1
  236. data/tools/docs/assets/js/7efc9fb0.6164fbad.js +0 -1
  237. data/tools/docs/assets/js/867640d5.28196e2c.js +0 -1
  238. data/tools/docs/assets/js/89e76475.5131b624.js +0 -1
  239. data/tools/docs/assets/js/8f7843ee.69e537b0.js +0 -1
  240. data/tools/docs/assets/js/9424f0b3.73086bed.js +0 -1
  241. data/tools/docs/assets/js/97535711.c7556831.js +0 -1
  242. data/tools/docs/assets/js/99581c43.30aef54d.js +0 -1
  243. data/tools/docs/assets/js/9d6e81d0.84fe3bb3.js +0 -1
  244. data/tools/docs/assets/js/9fb6059a.dc4760ab.js +0 -1
  245. data/tools/docs/assets/js/a182b3b3.25afec82.js +0 -1
  246. data/tools/docs/assets/js/a507c363.71a89240.js +0 -1
  247. data/tools/docs/assets/js/a677c089.2ec103f7.js +0 -1
  248. data/tools/docs/assets/js/a9987364.de63d165.js +0 -1
  249. data/tools/docs/assets/js/aa6b6c1b.6b24256f.js +0 -1
  250. data/tools/docs/assets/js/ada50b5c.1c75d3de.js +0 -1
  251. data/tools/docs/assets/js/b4596165.ab1c689f.js +0 -1
  252. data/tools/docs/assets/js/b6d70f94.ec27318b.js +0 -1
  253. data/tools/docs/assets/js/b9f60ba6.bb514133.js +0 -1
  254. data/tools/docs/assets/js/bd0034eb.0c60929d.js +0 -1
  255. data/tools/docs/assets/js/c24eae19.12176204.js +0 -1
  256. data/tools/docs/assets/js/cb8c3f08.762bb287.js +0 -1
  257. data/tools/docs/assets/js/cd879be4.3641a5cb.js +0 -1
  258. data/tools/docs/assets/js/d1b923aa.bf4b0c9e.js +0 -1
  259. data/tools/docs/assets/js/d24bf9b6.6ed3b576.js +0 -1
  260. data/tools/docs/assets/js/d370d7a7.28ef1aad.js +0 -1
  261. data/tools/docs/assets/js/d57a4b5d.017675ee.js +0 -1
  262. data/tools/docs/assets/js/d5d77c37.f472b18b.js +0 -1
  263. data/tools/docs/assets/js/d5f295fb.e008c3ec.js +0 -1
  264. data/tools/docs/assets/js/d7c988eb.2670948e.js +0 -1
  265. data/tools/docs/assets/js/d8ca4191.717db664.js +0 -1
  266. data/tools/docs/assets/js/d9b92eba.5eff70b2.js +0 -1
  267. data/tools/docs/assets/js/db8fa1d0.85784608.js +0 -1
  268. data/tools/docs/assets/js/dc5f7beb.120c148d.js +0 -1
  269. data/tools/docs/assets/js/e501b0d1.ae564e73.js +0 -1
  270. data/tools/docs/assets/js/f15615f1.3126a842.js +0 -1
  271. data/tools/docs/assets/js/fd886806.d2d0bdf4.js +0 -1
  272. data/tools/docs/assets/js/main.b5a535c2.js +0 -2
  273. data/tools/docs/assets/js/runtime~main.e3a6c705.js +0 -1
  274. data/tools/docs/docs/configuration/command.html +0 -40
  275. data/tools/docs/docs/configuration/format.html +0 -16
  276. data/tools/docs/docs/configuration/interfaces.html +0 -16
  277. data/tools/docs/docs/configuration/plugins.html +0 -17
  278. data/tools/docs/docs/configuration/protocols.html +0 -23
  279. data/tools/docs/docs/configuration/ssl-tls.html +0 -17
  280. data/tools/docs/docs/configuration/table.html +0 -30
  281. data/tools/docs/docs/configuration/target.html +0 -16
  282. data/tools/docs/docs/configuration/telemetry-screens.html +0 -36
  283. data/tools/docs/docs/configuration/telemetry.html +0 -16
  284. data/tools/docs/docs/configuration.html +0 -16
  285. data/tools/docs/docs/development/curl.html +0 -16
  286. data/tools/docs/docs/development/developing.html +0 -19
  287. data/tools/docs/docs/development/host-install.html +0 -16
  288. data/tools/docs/docs/development/json-api.html +0 -16
  289. data/tools/docs/docs/development/log-structure.html +0 -17
  290. data/tools/docs/docs/development/roadmap.html +0 -16
  291. data/tools/docs/docs/development/streaming-api.html +0 -18
  292. data/tools/docs/docs/development/testing.html +0 -16
  293. data/tools/docs/docs/development.html +0 -16
  294. data/tools/docs/docs/getting-started/gettingstarted.html +0 -16
  295. data/tools/docs/docs/getting-started/installation.html +0 -18
  296. data/tools/docs/docs/getting-started/podman.html +0 -18
  297. data/tools/docs/docs/getting-started/requirements.html +0 -16
  298. data/tools/docs/docs/getting-started/upgrading.html +0 -16
  299. data/tools/docs/docs/getting-started.html +0 -16
  300. data/tools/docs/docs/guides/bridges.html +0 -23
  301. data/tools/docs/docs/guides/cfs.html +0 -46
  302. data/tools/docs/docs/guides/custom-widgets.html +0 -16
  303. data/tools/docs/docs/guides/little-endian-bitfields.html +0 -16
  304. data/tools/docs/docs/guides/local-mode.html +0 -16
  305. data/tools/docs/docs/guides/logging.html +0 -16
  306. data/tools/docs/docs/guides/monitoring.html +0 -16
  307. data/tools/docs/docs/guides/performance.html +0 -16
  308. data/tools/docs/docs/guides/raspberrypi.html +0 -16
  309. data/tools/docs/docs/guides/script-writing.html +0 -18
  310. data/tools/docs/docs/guides/scripting-api.html +0 -17
  311. data/tools/docs/docs/guides.html +0 -16
  312. data/tools/docs/docs/meta/contributing.html +0 -20
  313. data/tools/docs/docs/meta/philosophy.html +0 -16
  314. data/tools/docs/docs/meta/xtce.html +0 -16
  315. data/tools/docs/docs/meta.html +0 -16
  316. data/tools/docs/docs/privacy.html +0 -23
  317. data/tools/docs/docs/tools/autonomic.html +0 -16
  318. data/tools/docs/docs/tools/bucket-explorer.html +0 -16
  319. data/tools/docs/docs/tools/calendar.html +0 -16
  320. data/tools/docs/docs/tools/cmd-sender.html +0 -16
  321. data/tools/docs/docs/tools/cmd-tlm-server.html +0 -17
  322. data/tools/docs/docs/tools/data-extractor.html +0 -16
  323. data/tools/docs/docs/tools/data-viewer.html +0 -16
  324. data/tools/docs/docs/tools/handbooks.html +0 -16
  325. data/tools/docs/docs/tools/limits-monitor.html +0 -16
  326. data/tools/docs/docs/tools/packet-viewer.html +0 -16
  327. data/tools/docs/docs/tools/script-runner.html +0 -16
  328. data/tools/docs/docs/tools/table-manager.html +0 -16
  329. data/tools/docs/docs/tools/tlm-grapher.html +0 -16
  330. data/tools/docs/docs/tools/tlm-viewer.html +0 -17
  331. data/tools/docs/docs/tools.html +0 -16
  332. data/tools/docs/docs/v5/bridges/index.html +0 -11
  333. data/tools/docs/docs/v5/bucket-explorer/index.html +0 -11
  334. data/tools/docs/docs/v5/calendar/index.html +0 -11
  335. data/tools/docs/docs/v5/cfs/index.html +0 -11
  336. data/tools/docs/docs/v5/cmd-sender/index.html +0 -11
  337. data/tools/docs/docs/v5/cmd-tlm-server/index.html +0 -11
  338. data/tools/docs/docs/v5/command/index.html +0 -11
  339. data/tools/docs/docs/v5/contributing/index.html +0 -11
  340. data/tools/docs/docs/v5/custom-widgets/index.html +0 -11
  341. data/tools/docs/docs/v5/data-extractor/index.html +0 -11
  342. data/tools/docs/docs/v5/data-viewer/index.html +0 -11
  343. data/tools/docs/docs/v5/development/index.html +0 -11
  344. data/tools/docs/docs/v5/format/index.html +0 -11
  345. data/tools/docs/docs/v5/gettingstarted/index.html +0 -11
  346. data/tools/docs/docs/v5/handbooks/index.html +0 -11
  347. data/tools/docs/docs/v5/host-install/index.html +0 -11
  348. data/tools/docs/docs/v5/index.html +0 -11
  349. data/tools/docs/docs/v5/installation/index.html +0 -11
  350. data/tools/docs/docs/v5/interfaces/index.html +0 -11
  351. data/tools/docs/docs/v5/json-api/index.html +0 -11
  352. data/tools/docs/docs/v5/limits-monitor/index.html +0 -11
  353. data/tools/docs/docs/v5/little-endian-bitfields/index.html +0 -11
  354. data/tools/docs/docs/v5/local-mode/index.html +0 -11
  355. data/tools/docs/docs/v5/log-structure/index.html +0 -11
  356. data/tools/docs/docs/v5/logging/index.html +0 -11
  357. data/tools/docs/docs/v5/monitoring/index.html +0 -11
  358. data/tools/docs/docs/v5/packet-viewer/index.html +0 -11
  359. data/tools/docs/docs/v5/performance/index.html +0 -11
  360. data/tools/docs/docs/v5/philosophy/index.html +0 -11
  361. data/tools/docs/docs/v5/plugins/index.html +0 -11
  362. data/tools/docs/docs/v5/podman/index.html +0 -11
  363. data/tools/docs/docs/v5/protocols/index.html +0 -11
  364. data/tools/docs/docs/v5/raspberrypi/index.html +0 -11
  365. data/tools/docs/docs/v5/requirements/index.html +0 -11
  366. data/tools/docs/docs/v5/roadmap/index.html +0 -11
  367. data/tools/docs/docs/v5/script-runner/index.html +0 -11
  368. data/tools/docs/docs/v5/script-writing/index.html +0 -11
  369. data/tools/docs/docs/v5/scripting-api/index.html +0 -11
  370. data/tools/docs/docs/v5/ssl-tls/index.html +0 -11
  371. data/tools/docs/docs/v5/streaming-api/index.html +0 -11
  372. data/tools/docs/docs/v5/table/index.html +0 -11
  373. data/tools/docs/docs/v5/table-manager/index.html +0 -11
  374. data/tools/docs/docs/v5/target/index.html +0 -11
  375. data/tools/docs/docs/v5/telemetry/index.html +0 -11
  376. data/tools/docs/docs/v5/telemetry-screens/index.html +0 -11
  377. data/tools/docs/docs/v5/testing/index.html +0 -11
  378. data/tools/docs/docs/v5/tlm-grapher/index.html +0 -11
  379. data/tools/docs/docs/v5/tlm-viewer/index.html +0 -11
  380. data/tools/docs/docs/v5/tools/index.html +0 -11
  381. data/tools/docs/docs/v5/upgrading/index.html +0 -11
  382. data/tools/docs/docs/v5/xtce/index.html +0 -11
  383. data/tools/docs/docs.html +0 -25
  384. data/tools/docs/index.html +0 -16
  385. data/tools/docs/lunr-index-1699630949575.json +0 -1
  386. data/tools/docs/lunr-index.json +0 -1
  387. data/tools/docs/markdown-page.html +0 -16
  388. data/tools/docs/search-doc-1699630949575.json +0 -1
  389. data/tools/docs/search-doc.json +0 -1
  390. data/tools/docs/sitemap.xml +0 -1
  391. /data/tools/{docs → staticdocs}/CNAME +0 -0
  392. /data/tools/{docs → staticdocs}/assets/images/add_packet-f318d0e92e8a13bd56331350aa341c88c8b12f2c54a4424f6e287817f22fb327.png +0 -0
  393. /data/tools/{docs → staticdocs}/assets/images/architecture-b78f12eba076a0c07af7abdd9dd4187c59aa6b4f5c51b47ad03f73e9f98a6ed6.png +0 -0
  394. /data/tools/{docs → staticdocs}/assets/images/autonomic-3d6d152f700c8fc1878d0f952d013ace31fccd7872d28587dc761610a0959e9c.png +0 -0
  395. /data/tools/{docs → staticdocs}/assets/images/bucket_explorer-983c087ee3bdcf8626219e782620b6c580fd82bfe2e8b0c662a0f90cdca43838.png +0 -0
  396. /data/tools/{docs → staticdocs}/assets/images/calendar-9fbd635cf3df1ba684bb0c1ebc4f6ad34991efc582e9fd07820c8b74cbb66aa1.png +0 -0
  397. /data/tools/{docs → staticdocs}/assets/images/checks_rb-a6049cdd99613cea2ee12d76fcfe798ff05270e39d208e93d37da7347049b2b3.png +0 -0
  398. /data/tools/{docs → staticdocs}/assets/images/cmd_tlm_server-313e3f64afc0e374d9d28b46364235d7b793001f84690fc0ae90e1eefdd9142d.png +0 -0
  399. /data/tools/{docs → staticdocs}/assets/images/command_sender-a0b113b65368263529d0f8f2d93276a0a44ed81af0d0100f56379346ba592928.png +0 -0
  400. /data/tools/{docs → staticdocs}/assets/images/commands-3608d5c856fd34e771d1f9e69f9f449f52929249bdf4f0e7feed0aa2bd2d9fd7.png +0 -0
  401. /data/tools/{docs → staticdocs}/assets/images/connecting-6e453f3d99800d4cb8fdc78f5b8fce1e8cf1bb04840a29dec7c5caefd07c004f.png +0 -0
  402. /data/tools/{docs → staticdocs}/assets/images/data_extractor-62c5b1743ba9dfdff2e393bcbdf863c36effc5ef5319d845cfd17186bd757bca.png +0 -0
  403. /data/tools/{docs → staticdocs}/assets/images/data_viewer-8c547cb5ad2ebd179aac5e46c2f4c147889ebad53a5359a5e6b6c580de7184fe.png +0 -0
  404. /data/tools/{docs → staticdocs}/assets/images/date_chooser-10f7b740b9acc76604e5dc86fe409b6b777abe0fb3fa5ebf8f47cb1ac58b9676.png +0 -0
  405. /data/tools/{docs → staticdocs}/assets/images/debug-04088348cc04bb8e1a1063fc44920dc8e39616840ef4b09a36c823f185c28669.png +0 -0
  406. /data/tools/{docs → staticdocs}/assets/images/delete_all_mouseover-06083f3d3d712d39f21bc5eda45adbfff449732a2061e53cb1a0baf6c5f5d4b8.png +0 -0
  407. /data/tools/{docs → staticdocs}/assets/images/delete_modified-a7ec0ceb61c37398d57fcecf11ebe2453ebd0110be6cfc960a5073a13a557638.png +0 -0
  408. /data/tools/{docs → staticdocs}/assets/images/edit_all_items-2c57aff19d3b1ce52149c37f50dcaad8c30baa0c9931fdc629f1d163bb56ce96.png +0 -0
  409. /data/tools/{docs → staticdocs}/assets/images/edit_all_mouseover-f6646df5320045ee10d4c0a15d0349fed6ede075f9cea6f9e449b3785c4f4f8d.png +0 -0
  410. /data/tools/{docs → staticdocs}/assets/images/edit_graph-4ca61635376fae26cf5eb82fb9fd803f1a51c4d3584aaf9833a270b7916bf531.png +0 -0
  411. /data/tools/{docs → staticdocs}/assets/images/edit_screen-5724ae13958c1631b3c187cf7cdb6dc9672ecd71f8b0786ac17c0266001edac3.png +0 -0
  412. /data/tools/{docs → staticdocs}/assets/images/edit_temp1-7446e7c5b7869ccc9ddd467779fa86f44301a5e5896751b016a527587c483cb2.png +0 -0
  413. /data/tools/{docs → staticdocs}/assets/images/file_menu-2fe13872737c0f3fef84ba5b58b80b609082733acce536ec1f56910c36f68299.png +0 -0
  414. /data/tools/{docs → staticdocs}/assets/images/file_open-319761fd383fc513b3689ef0a7498c73ce9459a3967c8a395cc2da07c89240d0.png +0 -0
  415. /data/tools/{docs → staticdocs}/assets/images/file_save_as-44468ed6a48bea3bc4fdd8f50d802569e4582b453e5bf946bfdcba400030d499.png +0 -0
  416. /data/tools/{docs → staticdocs}/assets/images/four_graphs-826cf8145338fa46e037556df94c59aeb4448330b601953daa94c89de8494cfd.png +0 -0
  417. /data/tools/{docs → staticdocs}/assets/images/graph_min_max-80a2bd83230c71b00ba9d6da24b8c32a09e4983976cdbf32c33d2680b534b106.png +0 -0
  418. /data/tools/{docs → staticdocs}/assets/images/graph_temp1-de937a79b314cf856b783c936d2460a6c942bdd45e4d9b3fe488957df5bfa9bc.png +0 -0
  419. /data/tools/{docs → staticdocs}/assets/images/graph_temp1_temp2-e96370f7d73a6cb68beaa92bcaaf18b72e6619ce948fe835762cca1048efbd18.png +0 -0
  420. /data/tools/{docs → staticdocs}/assets/images/graph_temp1_time-fec5e99e3cc05ea87208abe9c4b66b63b7497bbefee55f65d034417e966b1c46.png +0 -0
  421. /data/tools/{docs → staticdocs}/assets/images/handbooks-1d301c83c80a7cb96c548006f5139fe8ec967ed10a49df0142b37328cd987f33.png +0 -0
  422. /data/tools/{docs → staticdocs}/assets/images/ignored-1e20d4ffe7fd88ffab610340957b1176294269f985e8fdb20a9af07d7a78215f.png +0 -0
  423. /data/tools/{docs → staticdocs}/assets/images/inst_clear-5ecb859f06f14d91d2ebba27e5a7848d6393db5ad2357f95c12e776c45f6bc64.png +0 -0
  424. /data/tools/{docs → staticdocs}/assets/images/inst_collect-4f4e453a6521b779e10c4d2be6a8b1acf15fcb083af0164b0df1de27ca250132.png +0 -0
  425. /data/tools/{docs → staticdocs}/assets/images/inst_collect_hazardous-3aeabedb96bf114b4eb56b6b2ee7bcc601302ec8905a82a16c47ae7870f97978.png +0 -0
  426. /data/tools/{docs → staticdocs}/assets/images/inst_collect_hazardous_history-952a6e6ff2fb1b5fdf2c6b3d84a3ccf9e303eeb310f35514dc4a6e95f2a7420e.png +0 -0
  427. /data/tools/{docs → staticdocs}/assets/images/inst_collect_sent-0de429f724264ce8c52a6cb22d4bbb96f14e22b559c091ff4375bb59f124a7a2.png +0 -0
  428. /data/tools/{docs → staticdocs}/assets/images/inst_collect_sent_3-91cf4e053d246917964330ab93534a0a5eb878b652e7ea879effca7c4eaefbea.png +0 -0
  429. /data/tools/{docs → staticdocs}/assets/images/interface_read_logic-0deef27c1d2fec9de2a3720a3c9ecedb21a00dca7aabd13da0b8815c037e4c26.png +0 -0
  430. /data/tools/{docs → staticdocs}/assets/images/interface_write_logic-3360afe1b4af20b10dafba848a21e09baccaacc06e2ec8b6c132ac7a3c99e994.png +0 -0
  431. /data/tools/{docs → staticdocs}/assets/images/interfaces-5622abf50e3df63980661a48216bf71187f38cb636bd512f48917ca4a425f083.png +0 -0
  432. /data/tools/{docs → staticdocs}/assets/images/items_table-2fc1bb4d03a2348c4af7df442e13cee2f310cf455228005d76cbfda7a706aa53.png +0 -0
  433. /data/tools/{docs → staticdocs}/assets/images/items_table_raw-c4d454679c4503ec35710dcee6be5cd1940984595145b333d8604bc505dfe291.png +0 -0
  434. /data/tools/{docs → staticdocs}/assets/images/items_table_temp1-ea091eaf8005cea839800f4514f72f94e9664993111b935f33e7c5aa3061ca64.png +0 -0
  435. /data/tools/{docs → staticdocs}/assets/images/limits_monitor-c58d70daea7586b93d5069b9df068a90cea5f7cf2e51a445f3162bf3f66db3d0.png +0 -0
  436. /data/tools/{docs → staticdocs}/assets/images/list_view-926f42bc1e43283c61616b0cd8fd630cad8e15c9b7298acd98536842472e673b.png +0 -0
  437. /data/tools/{docs → staticdocs}/assets/images/log-ba64fd307e53adafae55fcea7eb31829ee1aacdf4aafe8b40b270b793be3aa27.png +0 -0
  438. /data/tools/{docs → staticdocs}/assets/images/log_messages-19c3ce9c7ff86e43d459cb6591df8c05d25e1390d857728cb462a57b9d3ccc69.png +0 -0
  439. /data/tools/{docs → staticdocs}/assets/images/log_messages-2cfad0fd6f6f980f69b5564a4b7ecfecf3331c6256c78bcfb2b084970db305ca.png +0 -0
  440. /data/tools/{docs → staticdocs}/assets/images/minimized-59d0d8d8a179ff0475787e87237b77b24d59d78826d43dbc1a554a51380eb37f.png +0 -0
  441. /data/tools/{docs → staticdocs}/assets/images/minimized-a658bd8f2115d3f9a386844e886de770b23bbf9c0c8c55a4ca587cea67ec320e.png +0 -0
  442. /data/tools/{docs → staticdocs}/assets/images/minio-150460ac77a50711835de6f0150d019000e5515afae0f3adfcdda8e891484f47.png +0 -0
  443. /data/tools/{docs → staticdocs}/assets/images/mouseover-95b774047b3c2ca23a3bc645caf75d90511c378729dd9cfb781510a1452e09fe.png +0 -0
  444. /data/tools/{docs → staticdocs}/assets/images/new_screen-295720ec60219194c8c8dd64c755e8a188cc4a68c2b6cf66197b54514644d52a.png +0 -0
  445. /data/tools/{docs → staticdocs}/assets/images/notifications-5b32d6619542431027ddd67491eb445469fa2d16fa8352a2b0917b9298b7bbb2.png +0 -0
  446. /data/tools/{docs → staticdocs}/assets/images/open_config-2e61415a3c2d7a4ce427cf325f3708dd4a761092b7dd0c869279c4354dc34ae4.png +0 -0
  447. /data/tools/{docs → staticdocs}/assets/images/open_config-3cd3be1ce4560d9e72bb37b83dc830149091dec9a088c36187e0e72660c6ec34.png +0 -0
  448. /data/tools/{docs → staticdocs}/assets/images/open_config-55ef2f241d02047b252bb8201742f99cffed5680d0e9eb46b3cb53a644ca3dc9.png +0 -0
  449. /data/tools/{docs → staticdocs}/assets/images/open_config-f848a8b371ae0ec31776834148e9f978d9be94efef03534e5ca3a59c0ae3847f.png +0 -0
  450. /data/tools/{docs → staticdocs}/assets/images/packet_viewer-19c1015cc704a98d1f6d90dd0dadc13188d25f1d5d2e838b7cfb226e8c173c7b.png +0 -0
  451. /data/tools/{docs → staticdocs}/assets/images/plugin-variables-5bc00c744182c9a9591e84cb3bbb1c4deb53ff22e05f62ce1b807c26bed782e5.png +0 -0
  452. /data/tools/{docs → staticdocs}/assets/images/processing-b0c50908284739a76e1bbcfcb3eb34dc9446f8716117cb0e9089ad9df53ebed6.png +0 -0
  453. /data/tools/{docs → staticdocs}/assets/images/project-fe7ac90f3e45971fca8f1be94be9dbabe494bafe705e7f8f485676e9d96e47ea.png +0 -0
  454. /data/tools/{docs → staticdocs}/assets/images/project_update-8e7de3b0658b95d4d9931eb52ff8bf339d633cbdc273ce096eb11ceb357c009e.png +0 -0
  455. /data/tools/{docs → staticdocs}/assets/images/raw_command-759d93759a73a6a3dd7e30f89fc4d1a544dfb6f7355abfed03897d404279161d.png +0 -0
  456. /data/tools/{docs → staticdocs}/assets/images/raw_telemetry-ffeb6b603f9a9abbe0cb77afaaeb4b4f07dfee479682a5c9661f85589a679049.png +0 -0
  457. /data/tools/{docs → staticdocs}/assets/images/raw_tlm_logs-8dcba4f020b36f8efbb793271b70d40d9cad627196afaeb5bf6f3931ed53fa52.png +0 -0
  458. /data/tools/{docs → staticdocs}/assets/images/reactions-dd4a8ebf22eed921a82a5478d23178c62e2cf944d295c2b9e3f4d7ce555b0fcc.png +0 -0
  459. /data/tools/{docs → staticdocs}/assets/images/reload_file-8e26cd3e1bc1eab7bb6c046d9a6a8231fcd76e56682d819b1e549182890c6486.png +0 -0
  460. /data/tools/{docs → staticdocs}/assets/images/reloaded-9effa15527244928ee503eb0c3a48cc5e82c07cfb5d5c4300eacfcab913069d1.png +0 -0
  461. /data/tools/{docs → staticdocs}/assets/images/running_scripts-78bfd36a6c8c7167234e03bd188e974927c2beea1f730498583169a81639e7a3.png +0 -0
  462. /data/tools/{docs → staticdocs}/assets/images/save_config-0ae36ac1f8114665f2558e936ba3b30e5cba2a16cc01d3494e14ed689b4637f7.png +0 -0
  463. /data/tools/{docs → staticdocs}/assets/images/save_config-8b028134b07c70d6de019825cbb328623fc485d72aad9ba5b1980246b316fec2.png +0 -0
  464. /data/tools/{docs → staticdocs}/assets/images/save_config-e4ed80276ebdc2c4eaf9aaeb859cff8aecb380b22da8c659741c31ca66914098.png +0 -0
  465. /data/tools/{docs → staticdocs}/assets/images/save_config-e748a338526ffd8f9e49def5c0d15f8a80cd987f40d210ff6c6d4b61b713555c.png +0 -0
  466. /data/tools/{docs → staticdocs}/assets/images/script_error-ce060b3086e7b466e51a276fb6b27245b4d042f07a60fe121b0071dd65a42075.png +0 -0
  467. /data/tools/{docs → staticdocs}/assets/images/script_runner-7d7f01b90be962b4de46c20568727c55488eec5d9844823b53a262c9cfc470fa.png +0 -0
  468. /data/tools/{docs → staticdocs}/assets/images/script_suite-42832d936f91417740b76a39841996c8e4a7cf5391dbb19abe9d7b31ab07dd7d.png +0 -0
  469. /data/tools/{docs → staticdocs}/assets/images/select_item-f063106a8d836656496ba81e7e7428f51bd8ab95aebab0aa4eb6ad41ed42e026.png +0 -0
  470. /data/tools/{docs → staticdocs}/assets/images/select_packet-0b6d5a2b012445ab2bf0fd3e1545f015cd7787280d05d2bccb0a9c9220102529.png +0 -0
  471. /data/tools/{docs → staticdocs}/assets/images/select_packet-be9d63c49f898cccb73f9e4b2b39c4b5879cead34a8ab2ede0bb08e953498e95.png +0 -0
  472. /data/tools/{docs → staticdocs}/assets/images/select_target-71ebcab6cbefafd8958939130861a75f7544e99a043d90fa0734ec2f983d835f.png +0 -0
  473. /data/tools/{docs → staticdocs}/assets/images/simple_screen-3c9d6d2366c716c03a301396a4ce0ea418532890f349d9bc9ebb8be90983a6e6.png +0 -0
  474. /data/tools/{docs → staticdocs}/assets/images/status-80010882300d2f1c453fbc4cb35bdb1f06d3db578266dda95c56ea7ec230ac72.png +0 -0
  475. /data/tools/{docs → staticdocs}/assets/images/table_manager-9a5357ce536102bc1bb0c859be552f4ac82f62e538935a3c45a8e76d4f9744db.png +0 -0
  476. /data/tools/{docs → staticdocs}/assets/images/targets-d15296b133787be4997c3d5e7d43eec9030831f1758508a8f6a71d40d04478ce.png +0 -0
  477. /data/tools/{docs → staticdocs}/assets/images/telemetry-3f1169fc67b3d2427047ba66a9b2f3ddf71f61edf498ee70d14e78f0ef3c1e3c.png +0 -0
  478. /data/tools/{docs → staticdocs}/assets/images/telemetry_grapher-a96b7e0101f5e377a73a186683e967e79d748c5dff2dfed6ec0afcea5694d7c8.png +0 -0
  479. /data/tools/{docs → staticdocs}/assets/images/telemetry_viewer-be6ee576f1efceb39c2f744889deb4c18f571c4922c69d5d0e5f49a653776a46.png +0 -0
  480. /data/tools/{docs → staticdocs}/assets/images/temp1_details-f0b6e62bc28da18febacc936112735e1dbd5718ef675668f04d8b3e060d7f87a.png +0 -0
  481. /data/tools/{docs → staticdocs}/assets/images/time_chooser-e4ca0705d5b97c3056b0de3ab7f71f8091482b9b2e8904e69866a43ce4e616f2.png +0 -0
  482. /data/tools/{docs → staticdocs}/assets/images/timeline_lifecycle-0bd916dee06bf67936b043abfdbc4d5fdec7cc5a32a889ee6c05e9faf74f4c6a.png +0 -0
  483. /data/tools/{docs → staticdocs}/assets/images/triggers-0b0b3f9cc2850c1b83b9a7aab6f8a936626fd847c3158e993e4baa0e64b38096.png +0 -0
  484. /data/tools/{docs → staticdocs}/assets/images/two_full_height-7cf9d0bbdf0269ad85e312f6dcb77930e1e3c4319f9750968a9347fafcf26084.png +0 -0
  485. /data/tools/{docs → staticdocs}/assets/images/two_full_width-db2d88c0e2e6fc417016f47e3bac0bf68374957d8fc014220f53870429ea1ef3.png +0 -0
  486. /data/tools/{docs → staticdocs}/assets/images/view_portal-b2e5fef00be80f1551b965d170fc3cd8ed95597f0a1e475a8177ab2d306215f5.png +0 -0
  487. /data/tools/{docs → staticdocs}/assets/images/view_portal_add-56f06135fc56f1fa85cbc22ea3b7ad52f311641aad25df08b6f4a6f979b30e3f.png +0 -0
  488. /data/tools/{docs → staticdocs}/assets/js/1131.f9e1547d.js +0 -0
  489. /data/tools/{docs → staticdocs}/assets/js/2923e883.0cbdcbc5.js +0 -0
  490. /data/tools/{docs/assets/js/3477.783e2e37.js.LICENSE.txt → staticdocs/assets/js/4657.9492019f.js.LICENSE.txt} +0 -0
  491. /data/tools/{docs → staticdocs}/assets/js/d797a795.9243eac2.js +0 -0
  492. /data/tools/{docs → staticdocs}/img/BCT.png +0 -0
  493. /data/tools/{docs → staticdocs}/img/OpenC3.png +0 -0
  494. /data/tools/{docs → staticdocs}/img/article-footer.png +0 -0
  495. /data/tools/{docs → staticdocs}/img/ball.jpg +0 -0
  496. /data/tools/{docs → staticdocs}/img/black_logo.svg +0 -0
  497. /data/tools/{docs → staticdocs}/img/captech.gif +0 -0
  498. /data/tools/{docs → staticdocs}/img/docusaurus-social-card.jpg +0 -0
  499. /data/tools/{docs → staticdocs}/img/docusaurus.png +0 -0
  500. /data/tools/{docs → staticdocs}/img/favicon.png +0 -0
  501. /data/tools/{docs → staticdocs}/img/footer-logo.png +0 -0
  502. /data/tools/{docs → staticdocs}/img/interface_read_logic.png +0 -0
  503. /data/tools/{docs → staticdocs}/img/interface_write_logic.png +0 -0
  504. /data/tools/{docs → staticdocs}/img/johnh.gif +0 -0
  505. /data/tools/{docs → staticdocs}/img/lockheed.png +0 -0
  506. /data/tools/{docs → staticdocs}/img/logo.svg +0 -0
  507. /data/tools/{docs → staticdocs}/img/nasa.gif +0 -0
  508. /data/tools/{docs → staticdocs}/img/sdlusu.gif +0 -0
  509. /data/tools/{docs → staticdocs}/img/v5/architecture.png +0 -0
  510. /data/tools/{docs → staticdocs}/img/v5/autonomic/autonomic.png +0 -0
  511. /data/tools/{docs → staticdocs}/img/v5/autonomic/reactions.png +0 -0
  512. /data/tools/{docs → staticdocs}/img/v5/autonomic/triggers.png +0 -0
  513. /data/tools/{docs → staticdocs}/img/v5/bucket_explorer/bucket_explorer.png +0 -0
  514. /data/tools/{docs → staticdocs}/img/v5/calendar/calendar.png +0 -0
  515. /data/tools/{docs → staticdocs}/img/v5/calendar/list_view.png +0 -0
  516. /data/tools/{docs → staticdocs}/img/v5/calendar/timeline_lifecycle.png +0 -0
  517. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/cmd_tlm_server.png +0 -0
  518. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/commands.png +0 -0
  519. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/file_menu.png +0 -0
  520. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/interfaces.png +0 -0
  521. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/log_messages.png +0 -0
  522. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/raw_command.png +0 -0
  523. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/raw_telemetry.png +0 -0
  524. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/routers.png +0 -0
  525. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/status.png +0 -0
  526. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/targets.png +0 -0
  527. /data/tools/{docs → staticdocs}/img/v5/cmd_tlm_server/telemetry.png +0 -0
  528. /data/tools/{docs → staticdocs}/img/v5/command_sender/command_sender.png +0 -0
  529. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_clear.png +0 -0
  530. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect.png +0 -0
  531. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_hazardous.png +0 -0
  532. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_hazardous_history.png +0 -0
  533. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_sent.png +0 -0
  534. /data/tools/{docs → staticdocs}/img/v5/command_sender/inst_collect_sent_3.png +0 -0
  535. /data/tools/{docs → staticdocs}/img/v5/command_sender/mode_menu.png +0 -0
  536. /data/tools/{docs → staticdocs}/img/v5/contact/jason.png +0 -0
  537. /data/tools/{docs → staticdocs}/img/v5/contact/ryan.jpeg +0 -0
  538. /data/tools/{docs → staticdocs}/img/v5/data_extractor/data_extractor.png +0 -0
  539. /data/tools/{docs → staticdocs}/img/v5/data_extractor/date_chooser.png +0 -0
  540. /data/tools/{docs → staticdocs}/img/v5/data_extractor/delete_all_mouseover.png +0 -0
  541. /data/tools/{docs → staticdocs}/img/v5/data_extractor/download.png +0 -0
  542. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_all_items.png +0 -0
  543. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_all_mouseover.png +0 -0
  544. /data/tools/{docs → staticdocs}/img/v5/data_extractor/edit_temp1.png +0 -0
  545. /data/tools/{docs → staticdocs}/img/v5/data_extractor/file_menu.png +0 -0
  546. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table.png +0 -0
  547. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table_raw.png +0 -0
  548. /data/tools/{docs → staticdocs}/img/v5/data_extractor/items_table_temp1.png +0 -0
  549. /data/tools/{docs → staticdocs}/img/v5/data_extractor/mode_menu.png +0 -0
  550. /data/tools/{docs → staticdocs}/img/v5/data_extractor/open_config.png +0 -0
  551. /data/tools/{docs → staticdocs}/img/v5/data_extractor/processing.png +0 -0
  552. /data/tools/{docs → staticdocs}/img/v5/data_extractor/save_config.png +0 -0
  553. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_item.png +0 -0
  554. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_packet.png +0 -0
  555. /data/tools/{docs → staticdocs}/img/v5/data_extractor/select_target.png +0 -0
  556. /data/tools/{docs → staticdocs}/img/v5/data_extractor/time_chooser.png +0 -0
  557. /data/tools/{docs → staticdocs}/img/v5/data_viewer/add_packet.png +0 -0
  558. /data/tools/{docs → staticdocs}/img/v5/data_viewer/data_viewer.png +0 -0
  559. /data/tools/{docs → staticdocs}/img/v5/data_viewer/file_menu.png +0 -0
  560. /data/tools/{docs → staticdocs}/img/v5/data_viewer/open_config.png +0 -0
  561. /data/tools/{docs → staticdocs}/img/v5/data_viewer/rename_tab.png +0 -0
  562. /data/tools/{docs → staticdocs}/img/v5/data_viewer/save_config.png +0 -0
  563. /data/tools/{docs → staticdocs}/img/v5/data_viewer/tab_right_click.png +0 -0
  564. /data/tools/{docs → staticdocs}/img/v5/data_viewer/view_portal.png +0 -0
  565. /data/tools/{docs → staticdocs}/img/v5/data_viewer/view_portal_add.png +0 -0
  566. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/delete_modified.png +0 -0
  567. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/minio.png +0 -0
  568. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/project.png +0 -0
  569. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/project_update.png +0 -0
  570. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/reload_file.png +0 -0
  571. /data/tools/{docs → staticdocs}/img/v5/guides/local_mode/reloaded.png +0 -0
  572. /data/tools/{docs → staticdocs}/img/v5/guides/logging/browser.png +0 -0
  573. /data/tools/{docs → staticdocs}/img/v5/guides/logging/log_messages.png +0 -0
  574. /data/tools/{docs → staticdocs}/img/v5/guides/logging/notifications.png +0 -0
  575. /data/tools/{docs → staticdocs}/img/v5/guides/logging/raw_tlm_logs.png +0 -0
  576. /data/tools/{docs → staticdocs}/img/v5/guides/plugin-variables.png +0 -0
  577. /data/tools/{docs → staticdocs}/img/v5/guides/simple_screen.png +0 -0
  578. /data/tools/{docs → staticdocs}/img/v5/handbooks/handbooks.png +0 -0
  579. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/ignored.png +0 -0
  580. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/limits_monitor.png +0 -0
  581. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/log.png +0 -0
  582. /data/tools/{docs → staticdocs}/img/v5/limits_monitor/mouseover.png +0 -0
  583. /data/tools/{docs → staticdocs}/img/v5/navigation.png +0 -0
  584. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/file_menu.png +0 -0
  585. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/packet_viewer.png +0 -0
  586. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/select_packet.png +0 -0
  587. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/temp1_details.png +0 -0
  588. /data/tools/{docs → staticdocs}/img/v5/packet_viewer/view_menu.png +0 -0
  589. /data/tools/{docs → staticdocs}/img/v5/script_runner/checks_rb.png +0 -0
  590. /data/tools/{docs → staticdocs}/img/v5/script_runner/connecting.png +0 -0
  591. /data/tools/{docs → staticdocs}/img/v5/script_runner/debug.png +0 -0
  592. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_menu.png +0 -0
  593. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_open.png +0 -0
  594. /data/tools/{docs → staticdocs}/img/v5/script_runner/file_save_as.png +0 -0
  595. /data/tools/{docs → staticdocs}/img/v5/script_runner/running_scripts.png +0 -0
  596. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_error.png +0 -0
  597. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_menu.png +0 -0
  598. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_runner.png +0 -0
  599. /data/tools/{docs → staticdocs}/img/v5/script_runner/script_suite.png +0 -0
  600. /data/tools/{docs → staticdocs}/img/v5/table_manager/file_menu.png +0 -0
  601. /data/tools/{docs → staticdocs}/img/v5/table_manager/table_manager.png +0 -0
  602. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/edit_graph.png +0 -0
  603. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/file_menu.png +0 -0
  604. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/four_graphs.png +0 -0
  605. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_menu.png +0 -0
  606. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_min_max.png +0 -0
  607. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1.png +0 -0
  608. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1_temp2.png +0 -0
  609. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/graph_temp1_time.png +0 -0
  610. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/grapher_controls.png +0 -0
  611. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/minimized.png +0 -0
  612. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/open_config.png +0 -0
  613. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/save_config.png +0 -0
  614. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/stop_start.png +0 -0
  615. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/telemetry_grapher.png +0 -0
  616. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/two_full_height.png +0 -0
  617. /data/tools/{docs → staticdocs}/img/v5/telemetry_grapher/two_full_width.png +0 -0
  618. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/edit_screen.png +0 -0
  619. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/file_menu.png +0 -0
  620. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/minimized.png +0 -0
  621. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/new_screen.png +0 -0
  622. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/open_config.png +0 -0
  623. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/save_config.png +0 -0
  624. /data/tools/{docs → staticdocs}/img/v5/telemetry_viewer/telemetry_viewer.png +0 -0
data/tools/staticdocs/docs/getting-started/gettingstarted.html ADDED
@@ -0,0 +1,128 @@
1
+ <!doctype html>
2
+ <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/gettingstarted" data-has-hydrated="false">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="generator" content="Docusaurus v3.0.0">
6
+ <title data-rh="true">Getting Started | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Getting Started | OpenC3 Docs"><meta data-rh="true" name="description" content="Welcome to the OpenC3 COSMOS system... Let&#x27;s get started! This guide is a high level overview that will help with setting up your first COSMOS project."><meta data-rh="true" property="og:description" content="Welcome to the OpenC3 COSMOS system... Let&#x27;s get started! This guide is a high level overview that will help with setting up your first COSMOS project."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.6e885bef.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.6ca622b3.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.1b3209ca.js" defer="defer"></script>
9
+ </head>
10
+ <body class="navigation-with-keyboard">
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</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">Getting Started</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>Getting Started</h1></header><p>Welcome to the OpenC3 COSMOS system... Let&#x27;s get started! This guide is a high level overview that will help with setting up your first COSMOS project.</p>
12
+ <ol>
13
+ <li>Get COSMOS Installed onto your computer by following the <a href="/tools/staticdocs/docs/getting-started/installation">Installation Guide</a>.<!-- -->
14
+ <ul>
15
+ <li>You should now have COSMOS installed and a Demo project available that we can make changes to.</li>
16
+ </ul>
17
+ </li>
18
+ <li>Browse to <a href="http://localhost:2900" target="_blank" rel="noopener noreferrer">http://localhost:2900</a>
19
+ <ul>
20
+ <li>The COSMOS Command and Telemetry Server will appear. This tool provides real-time information about each &quot;target&quot; in the system. Targets are external systems that receive commands and generate telemetry, often over ethernet or serial connections.</li>
21
+ </ul>
22
+ </li>
23
+ <li>Experiment with other COSMOS tools. This is a DEMO environment so you can&#x27;t break anything. Some things to try:<!-- -->
24
+ <ul>
25
+ <li>Use Command Sender to send individual commands.</li>
26
+ <li>Use Limits Monitor to watch for telemetry limits violations</li>
27
+ <li>Run some of the example scripts in Script Runner and Test Runner</li>
28
+ <li>View individual Telemetry packets in Packet Viewer</li>
29
+ <li>View detailed telemetry displays in Telemetry Viewer</li>
30
+ <li>Graph some data in Telemetry Grapher</li>
31
+ <li>View log type data in Data Viewer</li>
32
+ <li>Process log data with Data Extractor</li>
33
+ </ul>
34
+ </li>
35
+ </ol>
36
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Browser Version Issue</div><div class="admonitionContent_bl22"><p>When you try to load the page and it fails to load, check with the built-in web development tools / DevTools. We have seen some strange things with version of browsers. You can build to a version of browser if you need to by reading about the <a href="https://github.com/browserslist/browserslist" target="_blank" rel="noopener noreferrer">browserslist</a>. A typical failure results in:</p><div class="codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-text codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">unexpected token ||=</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 fix this make sure your browsers is compliant with the current settings in the <a href="https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/openc3-tool-base/.browserslistrc" target="_blank" rel="noopener noreferrer">.browserlistrc</a> file. You can change this and rebuild the image. Note: This can cause build speeds to increase or decrease.</p></div></div>
37
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="interfacing-with-your-hardware">Interfacing with Your Hardware<a href="#interfacing-with-your-hardware" class="hash-link" aria-label="Direct link to Interfacing with Your Hardware" title="Direct link to Interfacing with Your Hardware">​</a></h2>
38
+ <p>Playing with the COSMOS Demo is fun and all, but now you want to talk to your own real hardware? Let&#x27;s do it!</p>
39
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Install and Platform</div><div class="admonitionContent_bl22"><p>This guide assumes we&#x27;re on Windows and COSMOS is installed in C:\COSMOS. Adjust scripts and paths as necessary to match your platform and COSMOS installation directory.</p></div></div>
40
+ <ol>
41
+ <li>
42
+ <p>Before creating your own configuration you should uninstall the COSMOS Demo so you&#x27;re working with a clean COSMOS system. Click the Admin button and the PLUGINS tab. Then click the Trash can icon next to openc3-cosmos-demo to delete it. When you go back to the Command and Telemetry Server you should have a blank table with no interfaces.</p>
43
+ </li>
44
+ <li>
45
+ <p>If you followed the <a href="/tools/staticdocs/docs/getting-started/installation">Installation Guide</a> you should already be inside a cloned <a href="https://github.com/OpenC3/cosmos-project" target="_blank" rel="noopener noreferrer">openc3-project</a> which is in your PATH (necessary for openc3.bat / openc3.sh to be resolved). Inside this project it&#x27;s recommended to edit the README.md (<a href="https://www.markdownguide.org/" target="_blank" rel="noopener noreferrer">Markdown</a>) to describe your program / project.</p>
46
+ </li>
47
+ <li>
48
+ <p>Now we need to create a plugin. Plugins are how we add targets and microservices to COSMOS. Our plugin will contain a single target which contains all the information defining the packets (command and telemetry) that are needed to communicate with the target. Use the COSMOS plugin generator to create the correct structure:</p>
49
+ <div class="language-batch codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">C:\openc3-project&gt; openc3.bat cli generate plugin BOB</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
50
+ <p>This should create a new directory called &quot;openc3-cosmos-bob&quot; with a bunch of files in it. The full description of all the files is explained by the <a href="/tools/staticdocs/docs/configuration/plugins#plugin-directory-structure">Plugin Structure</a> page.</p>
51
+ </li>
52
+ </ol>
53
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Run as the Root user</div><div class="admonitionContent_bl22"><p>The cli runs as the default COSMOS container user which is the recommended practice. If you&#x27;re having issues running as that user you can run as the root user (effectively <code>docker run --user=root</code> ) by running <code>cliroot</code> instead of <code>cli</code> in any of the examples.</p></div></div>
54
+ <ol>
55
+ <li>
56
+ <p>Starting with <a href="https://openc3.com/news/2023/02/23/openc3-cosmos-5-5-0-released/" target="_blank" rel="noopener noreferrer">COSMOS v5.5.0</a>, the plugin generator creates just the plugin framework (previously it would also create a target). From within the newly created plugin directory, we generate a target.</p>
57
+ <div class="language-batch codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">C:\openc3-project&gt; cd openc3-cosmos-bob</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">openc3-cosmos-bob&gt; openc3.bat cli generate target BOB</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>
58
+ </li>
59
+ </ol>
60
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Generators</div><div class="admonitionContent_bl22"><p>There are a number of generators available. Run <code>openc3.bat cli generate</code> to see all the avilable options.</p></div></div>
61
+ <ol>
62
+ <li>
63
+ <p>The target generator creates a single target named BOB. Best practice is to create a single target per plugin to make it easier to share targets and upgrade them individually. Lets see what the target generator created for us. Open the openc3-cosmos-bob/targets/BOB/cmd_tlm/cmd.txt:</p>
64
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BOB</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</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;Packet description&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Keyword Name BitSize Type Min Max Default Description</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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID</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)">INT</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)">1</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;Identifier&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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</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)">10.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2.5</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value&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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BOOL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</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 constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Boolean&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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</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 constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;OpenC3&quot;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;The label to apply&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>
65
+ <p>What does this all mean?</p>
66
+ <ul>
67
+ <li>We created a COMMAND for target BOB named EXAMPLE.</li>
68
+ <li>The command is made up of BIG_ENDIAN parameters and is described by &quot;Packet description&quot;. Here we are using the append flavor of defining parameters which stacks them back to back as it builds up the packet and you don&#x27;t have to worry about defining the bit offset into the packet.</li>
69
+ <li>First we APPEND_ID_PARAMETER a parameter that is used to identify the packet called ID that is an 16-bit signed integer (INT) with a minimum value of 1, a maximum value of 1, and a default value of 1, that is described as the &quot;Identifier&quot;.</li>
70
+ <li>Next we APPEND_PARAMETER a parameter called VALUE that is a 32-bit float (FLOAT) that has a minimum value of 0, a maximum value of 10.5, and a default value of 2.5.</li>
71
+ <li>Then we APPEND_PARAMETER a third parameter called BOOL which is a 8-bit unsigned integer (UINT) with a minimum value of MIN (meaning the smallest value a UINT supports, e.g 0), a maximum value of MAX (largest value a UINT supports, e.g. 255), and a default value of 0. BOOL has two states which are just a fancy way of giving meaning to the integer values 0 and 1. The STATE FALSE has a value of 0 and the STATE TRUE has a value of 1.</li>
72
+ <li>Finally we APPEND_PARAMETER called LABEL which is a 0-bit (meaning it takes up all the remaining space in the packet) string (STRING) with a default value of &quot;OpenC3&quot;. Strings don&#x27;t have minimum or maximum values as that doesn&#x27;t make sense for STRING types.</li>
73
+ </ul>
74
+ <p>Check out the full <a href="/tools/staticdocs/docs/configuration/command">Command</a> documention for more.</p>
75
+ </li>
76
+ <li>
77
+ <p>Now open the openc3-cosmos-bob/targets/BOB/cmd_tlm/tlm.txt:</p>
78
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BOB</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">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;Telemetry description&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Keyword Name BitSize Type ID Description</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)">ID</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)">INT</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;Identifier&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)">VALUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;Value&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)">BOOL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</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;Boolean&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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</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)">LABEL</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 constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;The label to apply&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>
79
+ <ul>
80
+ <li>This time we created a TELEMETRY packet for target BOB called STATUS that contains BIG_ENDIAN items and is described as &quot;Telemetry description&quot;.</li>
81
+ <li>We start by defininig an ID_ITEM called ID that is a 16-bit signed integer (INT) with an id value of 1 and described as &quot;Identifier&quot;. Id items are used to take unidentified blobs of bytes and determine which packet they are. In this case if a blob comes in with a value of 1, at bit offset 0 (since we APPEND this item first), interpreted as a 16-bit integer, then this packet will be &quot;identified&quot; as STATUS. Note the first packet defined without any ID_ITEMS is a &quot;catch-all&quot; packet that matches all incoming data (even if the data lengths don&#x27;t match).</li>
82
+ <li>Next we define three items similar to the command definition above.</li>
83
+ </ul>
84
+ <p>Check out the full <a href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a> documention for more.</p>
85
+ </li>
86
+ <li>
87
+ <p>COSMOS has defined an example command and telemetry packet for our target. Most targets will obviously have more than one command and telemetry packet. To add more simply create additional COMMAND and TELEMETRY lines in your text files. Actual packets should match the structure of your command and telemetry. Be sure to add at least one unique <a href="/tools/staticdocs/docs/configuration/command#id_parameter">ID_PARAMETER</a> and <a href="/tools/staticdocs/docs/configuration/telemetry#id_item">ID_ITEM</a> so your packets can be distinguished from each other.</p>
88
+ </li>
89
+ <li>
90
+ <p>Now we need to tell COSMOS how to connect to our BOB target. Open the openc3-cosmos-bob/plugin.txt file:</p>
91
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Set VARIABLEs here to allow variation in your plugin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># See [Plugins](../configuration/plugins.md) for more information</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)">VARIABLE</span><span class="token plain"> bob_target_name </span><span class="token constant" style="color:rgb(130, 170, 255)">BOB</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Modify this according to your actual target connection</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># See [Interfaces](../configuration/interfaces.md) for more information</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)">BOB</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"> bob_target_name </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">%&gt;</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token string-literal string" style="color:rgb(173, 219, 103)">INTERFACE &lt;%= bob_target_name %&gt;</span><span class="token plain">_INT tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token operator" style="color:rgb(127, 219, 202)">%=</span><span class="token plain"> bob_target_name </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token operator" style="color:rgb(127, 219, 202)">&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>
92
+ <ul>
93
+ <li>This configures the plugin with a VARIABLE called bob_target_name with a default of &quot;BOB&quot;. When you install this plugin you will have the option to change the name of this target to something other than &quot;BOB&quot;. This is useful to avoid name conflicts and allows you to have multiple copies of the BOB target in your COSMOS system.</li>
94
+ <li>The TARGET line declares the new BOB target using the name from the variable. The &lt;%= %&gt; syntax is called ERB (embedded Ruby) and allows us to put variables into our text files, in this case referencing our bob_target_name.</li>
95
+ <li>The last line declares a new INTERFACE called (by default) BOB_INT that will connect as a TCP/IP client using the code in tcpip_client_interface.rb to address host.docker.internal (This adds an /etc/hosts entry to the correct IP address for the host&#x27;s gateway) using port 8080 for writing and 8081 for reading. It also has a write timeout of 10 seconds and reads will never timeout (nil). The TCP/IP stream will be interpreted using the COSMOS <a href="/tools/staticdocs/docs/configuration/protocols#burst-protocol">BURST</a> protocol which means it will read as much data as it can from the interface. For all the details on how to configure COSMOS interfaces please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interface Guide</a>. The MAP_TARGET line tells COSMOS that it will receive telemetry from and send commands to the BOB target using the BOB_INT interface.</li>
96
+ </ul>
97
+ </li>
98
+ </ol>
99
+ <div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>Variables Support Reusability</div><div class="admonitionContent_bl22"><p>In a plugin that you plan to reuse you should make things like hostnames and ports variables</p></div></div>
100
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="building-your-plugin">Building Your Plugin<a href="#building-your-plugin" class="hash-link" aria-label="Direct link to Building Your Plugin" title="Direct link to Building Your Plugin">​</a></h2>
101
+ <ol>
102
+ <li>
103
+ <p>Now we need to build our plugin and upload it to COSMOS.</p>
104
+ <div class="language-batch codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">C:\cosmos-project&gt; cd openc3-cosmos-bob</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">C:\cosmos-project\openc3-cosmos-bob&gt; ..\openc3.bat cli rake build VERSION=1.0.0</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Successfully built RubyGem</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Name: openc3-cosmos-bob</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Version: 1.0.0.20210618174517</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> File: openc3-cosmos-bob-1.0.0.20210618174517.gem</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
105
+ <ul>
106
+ <li>Note that the VERSION is required to specify the version to build. We recommend <a href="https://semver.org/" target="_blank" rel="noopener noreferrer">sematic versioning</a> when building your plugin so people using your plugin (including you) know when there are breaking changes.</li>
107
+ </ul>
108
+ </li>
109
+ <li>
110
+ <p>Once our plugin is built we need to upload it to COSMOS. Go back to the Admin page and click the Plugins Tab. Click on &quot;Click to Select Plugin&quot; and select the openc3-cosmos-bob-1.0.0.20210618174517.gem file. Then click Upload. Go back to the CmdTlmServer and you should see the plugin being deployed at which point the BOB_INT interface should appear and try to connect. Go ahead and click &#x27;Cancel&#x27; because unless you really have something listening on port 8080 this will never connect. At this point you can explore the other CmdTlmServer tabs and other tools to see your newly defined BOB target.</p>
111
+ </li>
112
+ <li>
113
+ <p>Let&#x27;s modify our BOB target and then update the copy in COSMOS. If you open Command Sender in COSMOS to BOB EXAMPLE you should see the VALUE parameter has value 2.5. Open the openc3-cosmos-bob/targets/BOB/cmd_tlm/cmd.txt and change the Default value for VALUE to 5 and the description to &quot;New Value&quot;.</p>
114
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BOB</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</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;Packet description&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Keyword Name BitSize Type Min Max Default Description</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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ID</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)">INT</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)">1</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;Identifier&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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VALUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</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)">10.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;New Value&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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BOOL</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</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 constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</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 string-literal string" style="color:rgb(173, 219, 103)">&quot;Boolean&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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</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_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LABEL</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 constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;OpenC3&quot;</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;The label to apply&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>
115
+ </li>
116
+ <li>
117
+ <p>Rebuild the plugin with a new VERSION number. Since we didn&#x27;t make any breaking changes we simply bump the patch release number:</p>
118
+ <div class="language-batch codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">C:\cosmos-project\openc3-cosmos-bob&gt; ..\openc3.bat cli rake build VERSION=1.0.1</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Successfully built RubyGem</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Name: openc3-cosmos-bob</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> Version: 1.0.1.20210618202504</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> File: openc3-cosmos-bob-1.0.1.20210618202504.gem</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>
119
+ </li>
120
+ <li>
121
+ <p>Go back to the Admin page and click the Plugins Tab. This time click the clock icon next to openc3-cosmos-bob-1.0.0 to Upgrade the plugin. Browse to the newly built plugin gem and select it. This will re-prompt for the plugin variables (bob_target_name) so don&#x27;t change the name and just click OK. You should see a message about the plugin being installed at which point the plugins list will change to openc3-cosmos-bob-1.0.1.20210618202504.gem. Go back to Command Sender and you should see the new Default value for VALUE is 5 and the description is &quot;New Value&quot;. We have upgraded our plugin!</p>
122
+ </li>
123
+ <li>
124
+ <p>At this point you can create a new plugin named after your real target and start modifying the interface and command and telemetry definitions to enable COSMOS to connect to and drive your target. If you run into trouble look for solutions on our <a href="https://github.com/OpenC3/cosmos/issues" target="_blank" rel="noopener noreferrer">Github Issues</a> page. If you would like to enquire about support contracts or professional COSMOS development please contact us at <a href="mailto:support@openc3.com" target="_blank" rel="noopener noreferrer">support@openc3.com</a>.</p>
125
+ </li>
126
+ </ol></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/getting-started/gettingstarted.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/installation"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Installation</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/upgrading"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Upgrading</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="#interfacing-with-your-hardware" class="table-of-contents__link toc-highlight">Interfacing with Your Hardware</a></li><li><a href="#building-your-plugin" class="table-of-contents__link toc-highlight">Building Your Plugin</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
127
+ </body>
128
+ </html>
data/tools/staticdocs/docs/getting-started/installation.html ADDED
@@ -0,0 +1,66 @@
1
+ <!doctype html>
2
+ <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/installation" data-has-hydrated="false">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="generator" content="Docusaurus v3.0.0">
6
+ <title data-rh="true">Installation | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | OpenC3 Docs"><meta data-rh="true" name="description" content="Installing OpenC3 COSMOS"><meta data-rh="true" property="og:description" content="Installing OpenC3 COSMOS"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.6e885bef.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.6ca622b3.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.1b3209ca.js" defer="defer"></script>
9
+ </head>
10
+ <body class="navigation-with-keyboard">
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#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/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</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">Installation</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>Installation</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="installing-openc3-cosmos">Installing OpenC3 COSMOS<a href="#installing-openc3-cosmos" class="hash-link" aria-label="Direct link to Installing OpenC3 COSMOS" title="Direct link to Installing OpenC3 COSMOS">​</a></h2>
12
+ <p>The following sections describe how to get OpenC3 COSMOS installed on various operating systems. This document should help you setup you host machine to allow you to have a running version of COSMOS in no time.</p>
13
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="installing-openc3-cosmos-on-host-machines">Installing OpenC3 COSMOS on Host Machines<a href="#installing-openc3-cosmos-on-host-machines" class="hash-link" aria-label="Direct link to Installing OpenC3 COSMOS on Host Machines" title="Direct link to Installing OpenC3 COSMOS on Host Machines">​</a></h2>
14
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="prerequisites">PREREQUISITES<a href="#prerequisites" class="hash-link" aria-label="Direct link to PREREQUISITES" title="Direct link to PREREQUISITES">​</a></h3>
15
+ <p>Install <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">Docker</a> and install <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener noreferrer">Docker Compose</a>.</p>
16
+ <ul>
17
+ <li>
18
+ <p>Minimum Resources allocated to Docker: 8GB RAM, 1 CPU, 80GB Disk</p>
19
+ </li>
20
+ <li>
21
+ <p>Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk</p>
22
+ </li>
23
+ <li>
24
+ <p>Docker on Windows with WSL2:</p>
25
+ <ul>
26
+ <li>
27
+ <p>WSL2 consumes 50% of total memory on Windows or 8GB, whichever is less. However, on Windows builds before 20175 (use <code>winver</code> to check) it consumes 80% of your total memory. This can have a negative effect on Windows performance!</p>
28
+ </li>
29
+ <li>
30
+ <p>On Windows builds &lt; 20175 or for more fine grained control, create C:\Users\&lt;username&gt;\<a href="https://docs.microsoft.com/en-us/windows/wsl/wsl-config" target="_blank" rel="noopener noreferrer">.wslconfig</a>. Suggested contents on a 32GB machine:</p>
31
+ <p>[wsl2]
32
+ memory=16GB
33
+ swap=0</p>
34
+ </li>
35
+ </ul>
36
+ </li>
37
+ </ul>
38
+ <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Important: Modify Docker Connection Timeouts</div><div class="admonitionContent_bl22"><p>Docker by default will break idle (no data) connections after a period of 5 minutes. This &quot;feature&quot; will eventually cause you problems if you don&#x27;t adjust the Docker settings. This may manifest as idle connections dropping or simplying failing to resume after data should have started flowing again. Find the file at C:\Users\username\AppData\Roaming\Docker\settings.json on Windows or ~/Library/Group Containers/group.com.docker/settings.json on MacOS. Modify the value <code>vpnKitMaxPortIdleTime</code> to change the timeout (recommend setting to 0). <strong>Note:</strong> 0 means no timeout (idle connections not dropped)</p></div></div>
39
+ <p><strong>Note:</strong> As of December 2021 the COSMOS Docker containers are based on the Alpine Docker image.</p>
40
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="clone-project">CLONE PROJECT<a href="#clone-project" class="hash-link" aria-label="Direct link to CLONE PROJECT" title="Direct link to CLONE PROJECT">​</a></h3>
41
+ <p>Since the COSMOS 5.0.9 release we recommend using the project template to get started.</p>
42
+ <p>git clone <a href="https://github.com/OpenC3/cosmos-project.git" target="_blank" rel="noopener noreferrer">https://github.com/OpenC3/cosmos-project.git</a></p>
43
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>Offline Installation</div><div class="admonitionContent_bl22"><p style="margin-bottom:20px">If you need to install in an offline environment you should first see if you&#x27;re able to directly use the COSMOS containers. If so you can first save the containers:</p><p style="margin-bottom:20px"><code>./openc3.sh util save</code></p><p style="margin-bottom:20px">By default this will download the &#x27;latest&#x27; images and create tar files in the &#x27;tmp&#x27; directory which you can transfer to your offline environment. You can pass a release after &#x27;save&#x27; to download a specific release (e.g. util save 5.12.0). Transfer the tar files to your offline environment&#x27;s project &#x27;tmp&#x27; dir and import them with:</p><p style="margin-bottom:20px"><code>./openc3.sh util load</code></p></div></div>
44
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="certificates">CERTIFICATES<a href="#certificates" class="hash-link" aria-label="Direct link to CERTIFICATES" title="Direct link to CERTIFICATES">​</a></h3>
45
+ <p>The COSMOS containers are designed to work and be built in the presence of an SSL Decryption device. To support this a cacert.pem file can be placed at the base of the COSMOS 5 project that includes any certificates needed by your organization. <strong>Note</strong>: If you set the path to the ssl file in the <code>SSL_CERT_FILE</code> environment variables the openc3 setup script will copy it and place it for the docker container to load.</p>
46
+ <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><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>SSL Issues</div><div class="admonitionContent_bl22"><p>Increasingly organizations are using some sort of SSL decryptor device which can cause curl and other command line tools like git to have SSL certificate problems. If installation fails with messages that involve &quot;certificate&quot;, &quot;SSL&quot;, &quot;self-signed&quot;, or &quot;secure&quot; this is the problem. IT typically sets up browsers to work correctly but not command line applications. Note that the file extension might not be .pem, it could be .pem, crt, .ca-bundle, .cer, .p7b, .p7s, or potentially something else.</p><p>The workaround is to get a proper local certificate file from your IT department that can be used by tools like curl (for example C:\Shared\Ball.pem). Doesn&#x27;t matter just somewhere with no spaces.</p><p>Then set the following environment variables to that path (ie. C:\Shared\Ball.pem)</p><p>SSL_CERT_FILE<br>
47
+ CURL_CA_BUNDLE<br>
48
+ REQUESTS_CA_BUNDLE<br></p><p>Here are some directions on environment variables in Windows: <a href="https://www.computerhope.com/issues/ch000549.htm" target="_blank" rel="noopener noreferrer">Windows Environment Variables</a></p><p>You will need to create new ones with the names above and set their value to the full path to the certificate file.</p></div></div>
49
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="run">RUN<a href="#run" class="hash-link" aria-label="Direct link to RUN" title="Direct link to RUN">​</a></h3>
50
+ <p>Add the locally cloned project directory to your path so you can directly use the batch file or shell script. In Windows this would be adding &quot;C:\openc3-project&quot; to the PATH. In Linux you would edit your shell&#x27;s rc file and export the PATH. For example, on a Mac add the following to ~/.zshrc: <code>export PATH=~/cosmos-project:$PATH</code>.</p>
51
+ <p>Run <code>openc3.bat run</code> (Windows), or <code>./openc3.sh run</code> (linux/Mac).</p>
52
+ <p>Note, you can edit the .env file and change OPENC3_TAG to a specific release (e.g. 5.0.9) rather than &#x27;latest&#x27;.</p>
53
+ <p>If you see an error indicating docker daemon is not running ensure Docker and Docker compose is installed and running. If it errors please try to run <code>docker --version</code> or <code>docker-compose --version</code> and try to run the start command again. If the error continues please include the version in your issue if you choose to create one.</p>
54
+ <p>Running <code>docker ps</code> can help show the running containers.</p>
55
+ <p><code>openc3.*</code> takes multiple arguments. Run with no arguments for help. An example run of openc3.sh with no arguments will show a usage guide.</p>
56
+ <div class="codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-text codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">./openc3.sh</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">Usage: ./openc3.sh [cli, cliroot, start, stop, cleanup, run, util]</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cli: run a cli command as the default user (&#x27;cli help&#x27; for more info)</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cliroot: run a cli command as the root user (&#x27;cli help&#x27; for more info)</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* start: start the docker-compose openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* stop: stop the running dockers for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cleanup: cleanup network and volumes for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* run: run the prebuilt containers for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* util: various helper commands</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
57
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="connect">CONNECT<a href="#connect" class="hash-link" aria-label="Direct link to CONNECT" title="Direct link to CONNECT">​</a></h3>
58
+ <p>Connect a web browser to <a href="http://localhost:2900" target="_blank" rel="noopener noreferrer">http://localhost:2900</a>. Set the password to whatever you want.</p>
59
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="next-steps">NEXT STEPS<a href="#next-steps" class="hash-link" aria-label="Direct link to NEXT STEPS" title="Direct link to NEXT STEPS">​</a></h3>
60
+ <p>Continue to <a href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a>.</p>
61
+ <hr>
62
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="feedback">Feedback<a href="#feedback" class="hash-link" aria-label="Direct link to Feedback" title="Direct link to Feedback">​</a></h3>
63
+ <div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>Find a problem in the documentation?</div><div class="admonitionContent_bl22"><p>Please [create an issue](<a href="https://github.com/OpenC3/cosmos/issues/new/choose%22%3Ecreate" target="_blank" rel="noopener noreferrer">https://github.com/OpenC3/cosmos/issues/new/choose&quot;&gt;create</a> an issue) on
64
+ GitHub describing what we can do to make it better.</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/getting-started/installation.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/gettingstarted"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</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="#installing-openc3-cosmos" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS</a></li><li><a href="#installing-openc3-cosmos-on-host-machines" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS on Host Machines</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">PREREQUISITES</a></li><li><a href="#clone-project" class="table-of-contents__link toc-highlight">CLONE PROJECT</a></li><li><a href="#certificates" class="table-of-contents__link toc-highlight">CERTIFICATES</a></li><li><a href="#run" class="table-of-contents__link toc-highlight">RUN</a></li><li><a href="#connect" class="table-of-contents__link toc-highlight">CONNECT</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">NEXT STEPS</a></li><li><a href="#feedback" class="table-of-contents__link toc-highlight">Feedback</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
65
+ </body>
66
+ </html>
data/tools/staticdocs/docs/getting-started/key_concepts.html ADDED
@@ -0,0 +1,45 @@
1
+ <!doctype html>
2
+ <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/key_concepts" data-has-hydrated="false">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="generator" content="Docusaurus v3.0.0">
6
+ <title data-rh="true">Key Concepts | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Key Concepts | OpenC3 Docs"><meta data-rh="true" name="description" content="Projects"><meta data-rh="true" property="og:description" content="Projects"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.6e885bef.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.6ca622b3.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.1b3209ca.js" defer="defer"></script>
9
+ </head>
10
+ <body class="navigation-with-keyboard">
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</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">Key Concepts</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"><h1>OpenC3 COSMOS Key Concepts</h1>
12
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="projects">Projects<a href="#projects" class="hash-link" aria-label="Direct link to Projects" title="Direct link to Projects">​</a></h2>
13
+ <p>The main COSMOS <a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer">repo</a> contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS <a href="https://github.com/OpenC3/cosmos-project" target="_blank" rel="noopener noreferrer">project</a> to launch COSMOS. The project consists of the <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh" target="_blank" rel="noopener noreferrer">openc3.sh</a> and <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat" target="_blank" rel="noopener noreferrer">openc3.bat</a> files for starting and stopping COSMOS, the <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> for configuring the COSMOS containers, and the <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik.</p>
14
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="containerization">Containerization<a href="#containerization" class="hash-link" aria-label="Direct link to Containerization" title="Direct link to Containerization">​</a></h2>
15
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="images">Images<a href="#images" class="hash-link" aria-label="Direct link to Images" title="Direct link to Images">​</a></h3>
16
+ <p>Per <a href="https://docs.docker.com/get-started/overview/#images" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;An image is a read-only template with instructions for creating a Docker container.&quot; The base operating system COSMOS uses is called <a href="https://www.alpinelinux.org/" target="_blank" rel="noopener noreferrer">Alpine Linux</a>. It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a <a href="https://docs.docker.com/engine/reference/builder/" target="_blank" rel="noopener noreferrer">Dockerfile</a> to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend.</p>
17
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="containers">Containers<a href="#containers" class="hash-link" aria-label="Direct link to Containers" title="Direct link to Containers">​</a></h3>
18
+ <p>Per <a href="https://www.docker.com/resources/what-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another.&quot; Also per <a href="https://docs.docker.com/guides/walkthroughs/what-is-a-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.&quot; COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.</p>
19
+ <p>The COSMOS Open Source containers consist of the following:</p>
20
+ <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-openc3-cosmos-init-1</td><td>Copies files to Minio and configures COSMOS then exits</td></tr><tr><td>cosmos-openc3-operator-1</td><td>Main COSMOS container that runs the interfaces and target mircoservices</td></tr><tr><td>cosmos-openc3-cosmos-cmd-tlm-api-1</td><td>Rails server that provides all the COSMOS API endpoints</td></tr><tr><td>cosmos-openc3-cosmos-script-runner-api-1</td><td>Rails server that provides the Script API endpoints</td></tr><tr><td>cosmos-openc3-redis-1</td><td>Serves the static target configuration</td></tr><tr><td>cosmos-openc3-redis-ephemeral-1</td><td>Serves the <a href="https://redis.io/docs/data-types/streams" target="_blank" rel="noopener noreferrer">streams</a> containing the raw and decomutated data</td></tr><tr><td>cosmos-openc3-minio-1</td><td>Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files</td></tr><tr><td>cosmos-openc3-traefik-1</td><td>Provides a reverse proxy and load balancer with routes to the COSMOS endpoints</td></tr></tbody></table>
21
+ <p>The container list for <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">Enterprise COSMOS</a> consists of the following:</p>
22
+ <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-enterprise-openc3-metrics-1</td><td>Rails server that provides metrics on COSMOS performance</td></tr><tr><td>cosmos-enterprise-openc3-keycloak-1</td><td>Single-Sign On service for authentication</td></tr><tr><td>cosmos-enterprise-openc3-postgresql-1</td><td>SQL Database for use by Keycloak</td></tr><tr><td>openc3-nfs *</td><td>Network File System pod only for use in Kubernetes to share code libraries between containers</td></tr></tbody></table>
23
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="docker-compose">Docker Compose<a href="#docker-compose" class="hash-link" aria-label="Direct link to Docker Compose" title="Direct link to Docker Compose">​</a></h3>
24
+ <p>Per <a href="https://docs.docker.com/compose/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application&#x27;s services. Then, with a single command, you create and start all the services from your configuration.&quot; OpenC3 uses compose files to both build and run COSMOS. The <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> is where ports are exposed and environment variables are used.</p>
25
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="environment-file">Environment File<a href="#environment-file" class="hash-link" aria-label="Direct link to Environment File" title="Direct link to Environment File">​</a></h3>
26
+ <p>COSMOS uses an <a href="https://docs.docker.com/compose/environment-variables/env-file/" target="_blank" rel="noopener noreferrer">environment file</a> along with Docker Compose to pass environment variables into the COSMOS runtime. This <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more.</p>
27
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="kubernetes">Kubernetes<a href="#kubernetes" class="hash-link" aria-label="Direct link to Kubernetes" title="Direct link to Kubernetes">​</a></h3>
28
+ <p>Per <a href="https://kubernetes.io/" target="_blank" rel="noopener noreferrer">Kubernetes.io</a>, &quot;Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery.&quot; <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides <a href="https://helm.sh/docs/topics/charts/" target="_blank" rel="noopener noreferrer">Helm charts</a> for easy deployment to Kubernetes in various cloud environments.</p>
29
+ <p>COSMOS Enterprise also provides <a href="https://www.terraform.io/" target="_blank" rel="noopener noreferrer">Terraform</a> scripts to deploy COSMOS infrastructure on various cloud environments.</p>
30
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="frontend">Frontend<a href="#frontend" class="hash-link" aria-label="Direct link to Frontend" title="Direct link to Frontend">​</a></h2>
31
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="vuejs">Vue.js<a href="#vuejs" class="hash-link" aria-label="Direct link to Vue.js" title="Direct link to Vue.js">​</a></h3>
32
+ <p>The COSMOS frontend is fully browser native and is implented in the Vue.js framework. Per <a href="https://vuejs.org/guide/introduction.html" target="_blank" rel="noopener noreferrer">Vue.js</a>, &quot;Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex.&quot; COSMOS utilizes Vue.js and the <a href="https://vuetifyjs.com/en/" target="_blank" rel="noopener noreferrer">Vuetify</a> Component Framework UI library to build all the COSMOS tools which run in the browser of your choice.</p>
33
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="single-spa">Single-Spa<a href="#single-spa" class="hash-link" aria-label="Direct link to Single-Spa" title="Direct link to Single-Spa">​</a></h3>
34
+ <p>While COSMOS itself is written in Vue.js, we utilize a technology called <a href="https://single-spa.js.org/" target="_blank" rel="noopener noreferrer">single-spa</a> to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelt, and Vue.</p>
35
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="astro-ux">Astro UX<a href="#astro-ux" class="hash-link" aria-label="Direct link to Astro UX" title="Direct link to Astro UX">​</a></h3>
36
+ <p>Per <a href="https://www.astrouxds.com/" target="_blank" rel="noopener noreferrer">AstroUXDS</a>, &quot;The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices.&quot; COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. <a href="https://www.astrouxds.com/components/clock/" target="_blank" rel="noopener noreferrer">Astro Clock</a>, COSMOS directly incorporates Astro components.</p>
37
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="backend">Backend<a href="#backend" class="hash-link" aria-label="Direct link to Backend" title="Direct link to Backend">​</a></h2>
38
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="redis">Redis<a href="#redis" class="hash-link" aria-label="Direct link to Redis" title="Direct link to Redis">​</a></h3>
39
+ <p><a href="https://redis.io/" target="_blank" rel="noopener noreferrer">Redis</a> is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our <a href="/tools/staticdocs/docs/getting-started/key_concepts#containers">container list</a> you&#x27;ll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into <a href="https://redis.io/docs/data-types/streams/" target="_blank" rel="noopener noreferrer">Redis streams</a>. The other redis container contains COSMOS configuration that is meant to persist. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides helm charts that setup <a href="https://redis.io/docs/management/scaling/" target="_blank" rel="noopener noreferrer">Redis Cluster</a> to perform horizontal scaling where data is shared across multiple Redis nodes.</p>
40
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="minio">MinIO<a href="#minio" class="hash-link" aria-label="Direct link to MinIO" title="Direct link to MinIO">​</a></h3>
41
+ <p><a href="https://min.io/" target="_blank" rel="noopener noreferrer">MinIO</a> is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don&#x27;t need to deploy Tomcat or Nginx for example.</p>
42
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="ruby-on-rails">Ruby on Rails<a href="#ruby-on-rails" class="hash-link" aria-label="Direct link to Ruby on Rails" title="Direct link to Ruby on Rails">​</a></h3>
43
+ <p>The COSMOS API and Script Runner backends are powered by <a href="https://rubyonrails.org/" target="_blank" rel="noopener noreferrer">Ruby on Rails</a>. Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks.</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/getting-started/key_concepts.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/upgrading"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrading</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/requirements"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Requirements and Design</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="#projects" class="table-of-contents__link toc-highlight">Projects</a></li><li><a href="#containerization" class="table-of-contents__link toc-highlight">Containerization</a><ul><li><a href="#images" class="table-of-contents__link toc-highlight">Images</a></li><li><a href="#containers" class="table-of-contents__link toc-highlight">Containers</a></li><li><a href="#docker-compose" class="table-of-contents__link toc-highlight">Docker Compose</a></li><li><a href="#environment-file" class="table-of-contents__link toc-highlight">Environment File</a></li><li><a href="#kubernetes" class="table-of-contents__link toc-highlight">Kubernetes</a></li></ul></li><li><a href="#frontend" class="table-of-contents__link toc-highlight">Frontend</a><ul><li><a href="#vuejs" class="table-of-contents__link toc-highlight">Vue.js</a></li><li><a href="#single-spa" class="table-of-contents__link toc-highlight">Single-Spa</a></li><li><a href="#astro-ux" class="table-of-contents__link toc-highlight">Astro UX</a></li></ul></li><li><a href="#backend" class="table-of-contents__link toc-highlight">Backend</a><ul><li><a href="#redis" class="table-of-contents__link toc-highlight">Redis</a></li><li><a href="#minio" class="table-of-contents__link toc-highlight">MinIO</a></li><li><a href="#ruby-on-rails" class="table-of-contents__link toc-highlight">Ruby on Rails</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
44
+ </body>
45
+ </html>