openc3-cosmos-tool-docs 6.8.1 → 6.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (309) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/Rakefile +1 -1
  4. data/tools/staticdocs/404.html +2 -2
  5. data/tools/staticdocs/assets/css/styles.946be27d.css +1 -0
  6. data/tools/staticdocs/assets/images/activity-35dc5e3ab907ff79a599ab728b7a4ace155d86835a09f0c6fa8ceebf184b7984.png +0 -0
  7. data/tools/staticdocs/assets/images/blank_calendar-e02977fafde5379efc62fbaf82686898bfc4745dd081d62e52e3ee94c46bff69.png +0 -0
  8. data/tools/staticdocs/assets/images/cmd_packets-e7906db3691ccd29600e09cf005f6f53be9d9332ba4c319a1e81e1c8c6b665ed.png +0 -0
  9. data/tools/staticdocs/assets/images/cmd_tlm_server-117772d4be1adbf89805f5b530da301b3dcc0d5085a552d779c9bc692bac4c44.png +0 -0
  10. data/tools/staticdocs/assets/images/create_activity1-5e5a8cee97e818c21e3447d96797b950fe25eb5d0e153ffc899183d28b7fd1be.png +0 -0
  11. data/tools/staticdocs/assets/images/create_activity2-12024f05a06874c9e7b544bac4bec1a263de1715dcb9fa2dc1aea054682e8269.png +0 -0
  12. data/tools/staticdocs/assets/images/create_metadata1-70387fe6ea1aafaee24b4192e76000b31ed60d3a54f957d761cefb5d21498814.png +0 -0
  13. data/tools/staticdocs/assets/images/create_metadata2-ebb8f148142b387c81df70f8a565b27942ff5f6cd5bc098a6d58a27a9b36c09e.png +0 -0
  14. data/tools/staticdocs/assets/images/create_note1-28feb5cf0ad0899db78059dc4ea2567dc9cb03c8c776f1c65dd959f2910481f4.png +0 -0
  15. data/tools/staticdocs/assets/images/create_note2-c0929ea9194606f256465cd6a6c97c60c175cf2ecbf56e6597d4886b4249fe1f.png +0 -0
  16. data/tools/staticdocs/assets/images/data_flows-6796d95b379f3f69e3fcf9629c68aae389f3d9a287db5b4d0bbc385d478134b4.png +0 -0
  17. data/tools/staticdocs/assets/images/gantt_view-3fe75622572f4a5bab2f73311127b71db5bf5aed475b90a2938c9ae61810ea54.png +0 -0
  18. data/tools/staticdocs/assets/images/interface_details-b71797d470007be1e0520bb5b859b4da9cd3411303388be9e6db914a99628dff.png +0 -0
  19. data/tools/staticdocs/assets/images/interfaces-05db0ed276077b796b54a3bca76bd0841bfb0d700456258c878359d332ff9f8f.png +0 -0
  20. data/tools/staticdocs/assets/images/list_view-edfc7b6fa90e43b85dd862f06c3662dee33b3c79be923a955706001d2f07eca4.png +0 -0
  21. data/tools/staticdocs/assets/images/options-4cb5e315138437db9f25c87feb4be2c61738c03bc3344d46977f44a94b0af738.png +0 -0
  22. data/tools/staticdocs/assets/images/protocol_details-408f871b0bd8440091ac95ca76cac353bb06d0b3a6c3f756dd11e7e746d7c20c.png +0 -0
  23. data/tools/staticdocs/assets/images/status-9b7ac4d919d196a2bf3379d0cb262c6609fb98074c744533bb9132097cb52155.png +0 -0
  24. data/tools/staticdocs/assets/images/targets-b07f7cd9f19a4ca02d2838a4de58c25168f01ee256e692878e3b27b833632aca.png +0 -0
  25. data/tools/staticdocs/assets/images/timeline-78e3ab74af1b600eb6640831133f0240a9c20047956b18b729263988a66b8e00.png +0 -0
  26. data/tools/staticdocs/assets/images/tlm_packets-18345c00fd6cc01a9f7a1e363fdf8375769ba5afa4ccf22c45925184eefc57ca.png +0 -0
  27. data/tools/staticdocs/assets/js/019369f3.64763f3d.js +1 -0
  28. data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +1 -0
  29. data/tools/staticdocs/assets/js/0686a885.3d58085e.js +1 -0
  30. data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +1 -0
  31. data/tools/staticdocs/assets/js/{0f5d161c.0727eb1b.js → 0f5d161c.978b9fee.js} +1 -1
  32. data/tools/staticdocs/assets/js/0ff569c9.27128023.js +1 -0
  33. data/tools/staticdocs/assets/js/10209fc9.669ef887.js +1 -0
  34. data/tools/staticdocs/assets/js/103cc3be.1a538098.js +1 -0
  35. data/tools/staticdocs/assets/js/13196248.e93bfd65.js +1 -0
  36. data/tools/staticdocs/assets/js/{13c1b4e4.6446ccbc.js → 13c1b4e4.9735bb59.js} +1 -1
  37. data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +1 -0
  38. data/tools/staticdocs/assets/js/{1e02e6a3.a89f2446.js → 1e02e6a3.da7b7250.js} +1 -1
  39. data/tools/staticdocs/assets/js/{2047b354.0955283c.js → 2047b354.c86efa5f.js} +1 -1
  40. data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +1 -0
  41. data/tools/staticdocs/assets/js/26b8abb2.858cb22d.js +1 -0
  42. data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +1 -0
  43. data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +1 -0
  44. data/tools/staticdocs/assets/js/3326.2db66e1b.js +4 -0
  45. data/tools/staticdocs/assets/js/3402.80344ef5.js +1 -0
  46. data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +1 -0
  47. data/tools/staticdocs/assets/js/{3dd7ef3b.f43cd057.js → 3dd7ef3b.ceb26a04.js} +1 -1
  48. data/tools/staticdocs/assets/js/40365d27.f6769d57.js +1 -0
  49. data/tools/staticdocs/assets/js/4071.821f3b2b.js +1 -0
  50. data/tools/staticdocs/assets/js/{411898ad.28293824.js → 411898ad.8ed3452c.js} +1 -1
  51. data/tools/staticdocs/assets/js/42170351.7ff72adc.js +1 -0
  52. data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +1 -0
  53. data/tools/staticdocs/assets/js/5072.9a0a2752.js +1 -0
  54. data/tools/staticdocs/assets/js/{53ca7c5b.9468b8ed.js → 53ca7c5b.3ae5bb0f.js} +1 -1
  55. data/tools/staticdocs/assets/js/54d0d530.2f7aa091.js +1 -0
  56. data/tools/staticdocs/assets/js/5525.dd1645b0.js +101 -0
  57. data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +1 -0
  58. data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +1 -0
  59. data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +1 -0
  60. data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +1 -0
  61. data/tools/staticdocs/assets/js/5e3ed378.821e5ed4.js +1 -0
  62. data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +1 -0
  63. data/tools/staticdocs/assets/js/6246.60dfff30.js +1 -0
  64. data/tools/staticdocs/assets/js/6831b732.dc5bae56.js +1 -0
  65. data/tools/staticdocs/assets/js/696b4199.d197d085.js +1 -0
  66. data/tools/staticdocs/assets/js/6b210247.d400f853.js +1 -0
  67. data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +1 -0
  68. data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +1 -0
  69. data/tools/staticdocs/assets/js/72c6d8a8.1bbde831.js +1 -0
  70. data/tools/staticdocs/assets/js/75e64983.338d2338.js +1 -0
  71. data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +1 -0
  72. data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +1 -0
  73. data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +1 -0
  74. data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +1 -0
  75. data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +1 -0
  76. data/tools/staticdocs/assets/js/{8434.a3e5442b.js → 9623.44668503.js} +1 -1
  77. data/tools/staticdocs/assets/js/{964eb012.4253acd5.js → 964eb012.c7f626c5.js} +1 -1
  78. data/tools/staticdocs/assets/js/97535711.a6342866.js +1 -0
  79. data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +1 -0
  80. data/tools/staticdocs/assets/js/{9d6e81d0.b9f15524.js → 9d6e81d0.879c9e9e.js} +1 -1
  81. data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +1 -0
  82. data/tools/staticdocs/assets/js/a677c089.758701f0.js +1 -0
  83. data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +1 -0
  84. data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +1 -0
  85. data/tools/staticdocs/assets/js/aa6b6c1b.b566ee29.js +1 -0
  86. data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +1 -0
  87. data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +1 -0
  88. data/tools/staticdocs/assets/js/b4596165.9e7f0be7.js +1 -0
  89. data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +1 -0
  90. data/tools/staticdocs/assets/js/{b9f60ba6.2c4823f0.js → b9f60ba6.63638354.js} +1 -1
  91. data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +1 -0
  92. data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +1 -0
  93. data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +1 -0
  94. data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +1 -0
  95. data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +1 -0
  96. data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +1 -0
  97. data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +1 -0
  98. data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +1 -0
  99. data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +1 -0
  100. data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +1 -0
  101. data/tools/staticdocs/assets/js/d5d77c37.e29ff552.js +1 -0
  102. data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +1 -0
  103. data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +1 -0
  104. data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +1 -0
  105. data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +1 -0
  106. data/tools/staticdocs/assets/js/dbe31111.4e811739.js +1 -0
  107. data/tools/staticdocs/assets/js/{dc5f7beb.15b70d4b.js → dc5f7beb.c703e464.js} +1 -1
  108. data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +1 -0
  109. data/tools/staticdocs/assets/js/f15615f1.8591b830.js +1 -0
  110. data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +1 -0
  111. data/tools/staticdocs/assets/js/{fd886806.f7bfd80c.js → fd886806.fb8a587e.js} +1 -1
  112. data/tools/staticdocs/assets/js/main.2bcd58cc.js +38 -0
  113. data/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js +1 -0
  114. data/tools/staticdocs/docs/configuration/accessors.html +46 -46
  115. data/tools/staticdocs/docs/configuration/command.html +97 -97
  116. data/tools/staticdocs/docs/configuration/conversions.html +53 -53
  117. data/tools/staticdocs/docs/configuration/format.html +22 -22
  118. data/tools/staticdocs/docs/configuration/interfaces.html +55 -55
  119. data/tools/staticdocs/docs/configuration/limits-response.html +10 -10
  120. data/tools/staticdocs/docs/configuration/plugins.html +127 -127
  121. data/tools/staticdocs/docs/configuration/processors.html +17 -17
  122. data/tools/staticdocs/docs/configuration/protocols.html +66 -66
  123. data/tools/staticdocs/docs/configuration/ssl-tls.html +15 -15
  124. data/tools/staticdocs/docs/configuration/table.html +53 -53
  125. data/tools/staticdocs/docs/configuration/target.html +21 -21
  126. data/tools/staticdocs/docs/configuration/telemetry-screens.html +289 -289
  127. data/tools/staticdocs/docs/configuration/telemetry.html +86 -86
  128. data/tools/staticdocs/docs/configuration.html +2 -2
  129. data/tools/staticdocs/docs/development/curl.html +14 -14
  130. data/tools/staticdocs/docs/development/developing.html +27 -27
  131. data/tools/staticdocs/docs/development/json-api.html +15 -15
  132. data/tools/staticdocs/docs/development/log-structure.html +13 -13
  133. data/tools/staticdocs/docs/development/roadmap.html +4 -4
  134. data/tools/staticdocs/docs/development/streaming-api.html +24 -24
  135. data/tools/staticdocs/docs/development/testing.html +20 -20
  136. data/tools/staticdocs/docs/development.html +2 -2
  137. data/tools/staticdocs/docs/getting-started/cli.html +39 -39
  138. data/tools/staticdocs/docs/getting-started/generators.html +25 -25
  139. data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
  140. data/tools/staticdocs/docs/getting-started/installation.html +23 -21
  141. data/tools/staticdocs/docs/getting-started/key-concepts.html +20 -20
  142. data/tools/staticdocs/docs/getting-started/podman.html +23 -23
  143. data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
  144. data/tools/staticdocs/docs/getting-started/upgrading.html +47 -47
  145. data/tools/staticdocs/docs/getting-started.html +2 -2
  146. data/tools/staticdocs/docs/guides/bridges.html +19 -12
  147. data/tools/staticdocs/docs/guides/cfs.html +32 -32
  148. data/tools/staticdocs/docs/guides/custom-widgets.html +36 -36
  149. data/tools/staticdocs/docs/guides/dynamic-packets.html +8 -8
  150. data/tools/staticdocs/docs/guides/exposing-microservices.html +11 -11
  151. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +4 -4
  152. data/tools/staticdocs/docs/guides/local-mode.html +13 -13
  153. data/tools/staticdocs/docs/guides/logging.html +9 -9
  154. data/tools/staticdocs/docs/guides/monitoring.html +18 -18
  155. data/tools/staticdocs/docs/guides/performance.html +10 -10
  156. data/tools/staticdocs/docs/guides/raspberrypi.html +4 -4
  157. data/tools/staticdocs/docs/guides/reference-architectures.html +6 -6
  158. data/tools/staticdocs/docs/guides/script-writing.html +80 -80
  159. data/tools/staticdocs/docs/guides/scripting-api.html +715 -635
  160. data/tools/staticdocs/docs/guides/troubleshooting.html +8 -7
  161. data/tools/staticdocs/docs/guides.html +2 -2
  162. data/tools/staticdocs/docs/meta/contributing.html +12 -12
  163. data/tools/staticdocs/docs/meta/licenses.html +9 -9
  164. data/tools/staticdocs/docs/meta/philosophy.html +3 -3
  165. data/tools/staticdocs/docs/meta/xtce.html +12 -12
  166. data/tools/staticdocs/docs/meta.html +2 -2
  167. data/tools/staticdocs/docs/privacy.html +17 -17
  168. data/tools/staticdocs/docs/tools/admin.html +24 -24
  169. data/tools/staticdocs/docs/tools/autonomic.html +19 -19
  170. data/tools/staticdocs/docs/tools/bucket-explorer.html +9 -9
  171. data/tools/staticdocs/docs/tools/calendar.html +34 -21
  172. data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
  173. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +31 -22
  174. data/tools/staticdocs/docs/tools/command-history.html +6 -6
  175. data/tools/staticdocs/docs/tools/command-queue.html +8 -8
  176. data/tools/staticdocs/docs/tools/data-extractor.html +25 -25
  177. data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
  178. data/tools/staticdocs/docs/tools/handbooks.html +4 -4
  179. data/tools/staticdocs/docs/tools/limits-monitor.html +16 -16
  180. data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
  181. data/tools/staticdocs/docs/tools/packet-viewer.html +12 -12
  182. data/tools/staticdocs/docs/tools/script-runner.html +43 -43
  183. data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
  184. data/tools/staticdocs/docs/tools/table-manager.html +11 -11
  185. data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -22
  186. data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
  187. data/tools/staticdocs/docs/tools.html +2 -2
  188. data/tools/staticdocs/docs.html +11 -11
  189. data/tools/staticdocs/img/calendar/activity.png +0 -0
  190. data/tools/staticdocs/img/calendar/blank_calendar.png +0 -0
  191. data/tools/staticdocs/img/calendar/create_activity1.png +0 -0
  192. data/tools/staticdocs/img/calendar/create_activity2.png +0 -0
  193. data/tools/staticdocs/img/calendar/create_metadata1.png +0 -0
  194. data/tools/staticdocs/img/calendar/create_metadata2.png +0 -0
  195. data/tools/staticdocs/img/calendar/create_note1.png +0 -0
  196. data/tools/staticdocs/img/calendar/create_note2.png +0 -0
  197. data/tools/staticdocs/img/calendar/gantt_view.png +0 -0
  198. data/tools/staticdocs/img/calendar/list_view.png +0 -0
  199. data/tools/staticdocs/img/calendar/options.png +0 -0
  200. data/tools/staticdocs/img/calendar/timeline.png +0 -0
  201. data/tools/staticdocs/img/cmd_tlm_server/cmd_packets.png +0 -0
  202. data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
  203. data/tools/staticdocs/img/cmd_tlm_server/data_flows.png +0 -0
  204. data/tools/staticdocs/img/cmd_tlm_server/interface_details.png +0 -0
  205. data/tools/staticdocs/img/cmd_tlm_server/interfaces.png +0 -0
  206. data/tools/staticdocs/img/cmd_tlm_server/protocol_details.png +0 -0
  207. data/tools/staticdocs/img/cmd_tlm_server/routers.png +0 -0
  208. data/tools/staticdocs/img/cmd_tlm_server/status.png +0 -0
  209. data/tools/staticdocs/img/cmd_tlm_server/targets.png +0 -0
  210. data/tools/staticdocs/img/cmd_tlm_server/tlm_packets.png +0 -0
  211. data/tools/staticdocs/index.html +2 -2
  212. data/tools/staticdocs/lunr-index-1759687174225.json +1 -0
  213. data/tools/staticdocs/lunr-index.json +1 -1
  214. data/tools/staticdocs/markdown-page.html +3 -3
  215. data/tools/staticdocs/search-doc-1759687174225.json +1 -0
  216. data/tools/staticdocs/search-doc.json +1 -1
  217. metadata +120 -107
  218. data/tools/staticdocs/assets/css/styles.0edf3032.css +0 -1
  219. data/tools/staticdocs/assets/images/blank_calendar-70e605942120937b862bd7039348229bab9af1f9c93d356ddbf401a3e8543c74.png +0 -0
  220. data/tools/staticdocs/assets/images/calendar-dacbcbb05175c76f3406b4aaade0465444c20b72e93366c79fed1f6eec018c42.png +0 -0
  221. data/tools/staticdocs/assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png +0 -0
  222. data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
  223. data/tools/staticdocs/assets/images/create_activity1-c05ffc03af2df852aeb3ad246f53f259af504e0e6c64cdac21f9126947c49f95.png +0 -0
  224. data/tools/staticdocs/assets/images/create_activity2-58c7da6f79dd510701148c0c54fae02c830b9ca4af662a7b132987ed3410a8f7.png +0 -0
  225. data/tools/staticdocs/assets/images/create_metadata1-a331ba8f0bd19bf5f8d7f2e083c3c7164e9b7b9936f5a7f83c4141c62a6c46f6.png +0 -0
  226. data/tools/staticdocs/assets/images/create_metadata2-c57b5420d5469b48289030ed7c64758539c2319dc742159caa0d4c8fe35050a8.png +0 -0
  227. data/tools/staticdocs/assets/images/create_note1-472b93e8e0e3e66a2e6198e0d4573cdc38cc356df87be66163f990f18137f6c0.png +0 -0
  228. data/tools/staticdocs/assets/images/create_note2-770501a149ef4aabae24d0b636f46ed61fbdcfda9537c61637c07c60257e9228.png +0 -0
  229. data/tools/staticdocs/assets/images/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png +0 -0
  230. data/tools/staticdocs/assets/images/list_view-2f36ce06962e67d5a4f1f060956e5089b3f13c8ab57f33103c3781687611e7a9.png +0 -0
  231. data/tools/staticdocs/assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png +0 -0
  232. data/tools/staticdocs/assets/images/targets-6b17daf175185b13bea9eddafd4773e5f41d1ef4e953134f30bee0799c1e5c31.png +0 -0
  233. data/tools/staticdocs/assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png +0 -0
  234. data/tools/staticdocs/assets/js/019369f3.5366d64b.js +0 -1
  235. data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +0 -1
  236. data/tools/staticdocs/assets/js/0686a885.eb311155.js +0 -1
  237. data/tools/staticdocs/assets/js/078dbab0.974abc47.js +0 -1
  238. data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +0 -1
  239. data/tools/staticdocs/assets/js/10209fc9.ae369363.js +0 -1
  240. data/tools/staticdocs/assets/js/103cc3be.32c30401.js +0 -1
  241. data/tools/staticdocs/assets/js/1085.d1eba438.js +0 -1
  242. data/tools/staticdocs/assets/js/1319.d9ec0592.js +0 -101
  243. data/tools/staticdocs/assets/js/13196248.9e1ebaa5.js +0 -1
  244. data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +0 -1
  245. data/tools/staticdocs/assets/js/22b3ac48.81906212.js +0 -1
  246. data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +0 -1
  247. data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +0 -1
  248. data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +0 -1
  249. data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +0 -1
  250. data/tools/staticdocs/assets/js/40365d27.db29df30.js +0 -1
  251. data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +0 -1
  252. data/tools/staticdocs/assets/js/43652efd.35825078.js +0 -1
  253. data/tools/staticdocs/assets/js/5074.653f3924.js +0 -1
  254. data/tools/staticdocs/assets/js/5410.60ab1dba.js +0 -1
  255. data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +0 -1
  256. data/tools/staticdocs/assets/js/59ed27a4.8eb3444b.js +0 -1
  257. data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +0 -1
  258. data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +0 -1
  259. data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +0 -1
  260. data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +0 -1
  261. data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +0 -1
  262. data/tools/staticdocs/assets/js/6242.bdac32c1.js +0 -4
  263. data/tools/staticdocs/assets/js/6831b732.7cf97282.js +0 -1
  264. data/tools/staticdocs/assets/js/696b4199.b96d263c.js +0 -1
  265. data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +0 -1
  266. data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +0 -1
  267. data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +0 -1
  268. data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +0 -1
  269. data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +0 -1
  270. data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +0 -1
  271. data/tools/staticdocs/assets/js/8851.4837d29a.js +0 -1
  272. data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +0 -1
  273. data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +0 -1
  274. data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +0 -1
  275. data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +0 -1
  276. data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +0 -1
  277. data/tools/staticdocs/assets/js/99581c43.791cdc39.js +0 -1
  278. data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +0 -1
  279. data/tools/staticdocs/assets/js/a677c089.2695e35a.js +0 -1
  280. data/tools/staticdocs/assets/js/a9987364.71b17b00.js +0 -1
  281. data/tools/staticdocs/assets/js/a9b2dc27.c8eb51b6.js +0 -1
  282. data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +0 -1
  283. data/tools/staticdocs/assets/js/b062d239.e240f32e.js +0 -1
  284. data/tools/staticdocs/assets/js/b38a6d74.7363be85.js +0 -1
  285. data/tools/staticdocs/assets/js/b4596165.2a473696.js +0 -1
  286. data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +0 -1
  287. data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +0 -1
  288. data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +0 -1
  289. data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +0 -1
  290. data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +0 -1
  291. data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +0 -1
  292. data/tools/staticdocs/assets/js/d1b923aa.482b8f7b.js +0 -1
  293. data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +0 -1
  294. data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +0 -1
  295. data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +0 -1
  296. data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +0 -1
  297. data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +0 -1
  298. data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +0 -1
  299. data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +0 -1
  300. data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +0 -1
  301. data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +0 -1
  302. data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +0 -1
  303. data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +0 -1
  304. data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +0 -1
  305. data/tools/staticdocs/assets/js/f75a5f33.4d2501bc.js +0 -1
  306. data/tools/staticdocs/assets/js/main.994f9f74.js +0 -38
  307. data/tools/staticdocs/assets/js/runtime~main.44311138.js +0 -1
  308. data/tools/staticdocs/lunr-index-1757781681330.json +0 -1
  309. data/tools/staticdocs/search-doc-1757781681330.json +0 -1
@@ -1,22 +1,22 @@
1
- <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/json-api" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>JSON API | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/json-api><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="JSON API | OpenC3 Docs"><meta data-rh=true name=description content="Interfacing to the COSMOS APIs using JSON-RPC"><meta data-rh=true property=og:description content="Interfacing to the COSMOS APIs using JSON-RPC"><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/development/json-api><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/json-api hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/json-api hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/json-api","name":"JSON API","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.0edf3032.css><script src=/tools/staticdocs/assets/js/runtime~main.44311138.js defer></script><script src=/tools/staticdocs/assets/js/main.994f9f74.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/json-api" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>JSON API | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/json-api /><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="JSON API | OpenC3 Docs"/><meta data-rh=true name=description content="Interfacing to the COSMOS APIs using JSON-RPC"/><meta data-rh=true property=og:description content="Interfacing to the COSMOS APIs using JSON-RPC"/><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/development/json-api /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/json-api hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/json-api hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/json-api","name":"JSON API","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
2
2
  <symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
3
3
  </defs></svg>
4
- <script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl>Testing with Curl</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing>Developing COSMOS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/json-api>JSON API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/log-structure>Log Structure</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/roadmap>Roadmap</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api>Streaming API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing>Testing COSMOS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>JSON API</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>JSON API</h1></header><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"/></svg></span>This documentation is for COSMOS Developers</div><div class=admonitionContent_bl22><p>If you're looking for the methods available to write test procedures using the COSMOS scripting API, refer to the <a href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a> page. If you're trying to interface to COSMOS from an external application using any language then this is the right place.</div></div>
4
+ <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><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><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl><span title="Testing with Curl" class=linkLabel_THKR>Testing with Curl</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing><span title="Developing COSMOS" class=linkLabel_THKR>Developing COSMOS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/json-api><span title="JSON API" class=linkLabel_THKR>JSON API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/log-structure><span title="Log Structure" class=linkLabel_THKR>Log Structure</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/roadmap><span title=Roadmap class=linkLabel_THKR>Roadmap</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api><span title="Streaming API" class=linkLabel_THKR>Streaming API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing><span title="Testing COSMOS" class=linkLabel_THKR>Testing COSMOS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>JSON API</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>JSON API</h1></header><div class="theme-admonition theme-admonition-note admonition_AUqJ alert alert--secondary"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><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"/></svg></span>This documentation is for COSMOS Developers</div><div class=admonitionContent_ISwi><p>If you're looking for the methods available to write test procedures using the COSMOS scripting API, refer to the <a href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a> page. If you're trying to interface to COSMOS from an external application using any language then this is the right place.</div></div>
5
5
  <p>This document provides the information necessary for external applications to interact with COSMOS using the COSMOS API. External applications written in any language can send commands and retrieve individual telemetry points using this API. External applications also have the option of connecting to the COSMOS Command and Telemetry server to interact with raw tcp/ip streams of commands/telemetry. However, the COSMOS JSON API removes the requirement that external applications have knowledge of the binary formats of packets.</p>
6
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=authorization>Authorization<a href=#authorization class=hash-link aria-label="Direct link to Authorization" title="Direct link to Authorization">​</a></h2>
6
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=authorization>Authorization<a href=#authorization class=hash-link aria-label="Direct link to Authorization" title="Direct link to Authorization" translate=no>​</a></h2>
7
7
  <p>The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually, but not necessarily, after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.</p>
8
- <div class="language-text codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><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">Authorization: &lt;token/password></span><br></span></code></pre></div></div>
9
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=json-rpc-20>JSON-RPC 2.0<a href=#json-rpc-20 class=hash-link aria-label="Direct link to JSON-RPC 2.0" title="Direct link to JSON-RPC 2.0">​</a></h2>
8
+ <div class="language-text codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-text codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">Authorization: &lt;token/password></span><br/></span></code></pre></div></div>
9
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=json-rpc-20>JSON-RPC 2.0<a href=#json-rpc-20 class=hash-link aria-label="Direct link to JSON-RPC 2.0" title="Direct link to JSON-RPC 2.0" translate=no>​</a></h2>
10
10
  <p>The COSMOS API implements a relaxed version of the <a href=http://www.jsonrpc.org/specification target=_blank rel="noopener noreferrer">JSON-RPC 2.0 Specification</a>. Requests with an "id" of NULL are not supported. Numbers can contain special non-string literal's such as NaN, and +/-inf. Request params must be specified by-position, by-name is not supported. Section 6 of the spec, Batch Operations, is not supported. The COSMOS scope must be specified in a <code>"keyword_params"</code> object.</p>
11
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=socket-connections>Socket Connections<a href=#socket-connections class=hash-link aria-label="Direct link to Socket Connections" title="Direct link to Socket Connections">​</a></h2>
11
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=socket-connections>Socket Connections<a href=#socket-connections class=hash-link aria-label="Direct link to Socket Connections" title="Direct link to Socket Connections" translate=no>​</a></h2>
12
12
  <p>The COSMOS Command and Telemetry Server listens for connections to the COSMOS API on an HTTP server (default port of 7777).</p>
13
13
  <p>COSMOS listens for HTTP API requests at the default 2900 port at the <code>/openc3-api/api</code> endpoint.</p>
14
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=supported-methods>Supported Methods<a href=#supported-methods class=hash-link aria-label="Direct link to Supported Methods" title="Direct link to Supported Methods">​</a></h2>
14
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=supported-methods>Supported Methods<a href=#supported-methods class=hash-link aria-label="Direct link to Supported Methods" title="Direct link to Supported Methods" translate=no>​</a></h2>
15
15
  <p>The list of methods supported by the COSMOS API may be found in the <a href=https://github.com/openc3/cosmos/tree/main/openc3/lib/openc3/api target=_blank rel="noopener noreferrer">api</a> source code on Github. The @api_whitelist variable is initialized with an array of all methods accepted by the CTS. This page will not show the full argument list for every method in the API, but it should be noted that the JSON API methods correspond to the COSMOS scripting API methods documented in the <a href=/tools/staticdocs/docs/guides/script-writing>Scripting Writing Guide</a>. This page will show a few example JSON requests and responses, and the scripting guide can be used as a reference to extrapolate how to build requests and parse responses for methods not explicitly documented here.</p>
16
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=existing-implementations>Existing Implementations<a href=#existing-implementations class=hash-link aria-label="Direct link to Existing Implementations" title="Direct link to Existing Implementations">​</a></h2>
16
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=existing-implementations>Existing Implementations<a href=#existing-implementations class=hash-link aria-label="Direct link to Existing Implementations" title="Direct link to Existing Implementations" translate=no>​</a></h2>
17
17
  <p>The COSMOS JSON API has been implemented in the following languages: Ruby, Python and Javascript.</p>
18
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=example-usage>Example Usage<a href=#example-usage class=hash-link aria-label="Direct link to Example Usage" title="Direct link to Example Usage">​</a></h2>
19
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=sending-commands>Sending Commands<a href=#sending-commands class=hash-link aria-label="Direct link to Sending Commands" title="Direct link to Sending Commands">​</a></h3>
18
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=example-usage>Example Usage<a href=#example-usage class=hash-link aria-label="Direct link to Example Usage" title="Direct link to Example Usage" translate=no>​</a></h2>
19
+ <h3 class="anchor anchorWithStickyNavbar_TUrh" id=sending-commands>Sending Commands<a href=#sending-commands class=hash-link aria-label="Direct link to Sending Commands" title="Direct link to Sending Commands" translate=no>​</a></h3>
20
20
  <p>The following methods are used to send commands: cmd, cmd_no_range_check, cmd_no_hazardous_check, cmd_no_checks</p>
21
21
  <p>The cmd method sends a command to a COSMOS target in the system. The cmd_no_range_check method does the same but ignores parameter range errors. The cmd_no_hazardous_check method does the same, but allows hazardous commands to be sent. The cmd_no_checks method does the same but allows hazardous commands to be sent, and ignores range errors.</p>
22
22
  <p>Two parameter syntaxes are supported.</p>
@@ -25,8 +25,8 @@
25
25
  <p>The second is two or three parameters with the first parameter being a string denoting the target name, the second being a string with the command name, and an optional third being a hash of parameter names/values. This format should be used if the command contains parameters that take binary data that is not capable of being expressed as ASCII text. The cmd and cmd_no_range_check methods will fail on all attempts to send a command that has been marked hazardous. To send hazardous commands, the cmd_no_hazardous_check, or cmd_no_checks methods must be used.</p>
26
26
  <table><thead><tr><th>Parameter<th>Data Type<th>Description<tbody><tr><td>target_name<td>String<td>Name of the target to send the command to<tr><td>command_name<td>String<td>The name of the command<tr><td>command_params<td>Hash<td>Optional hash of command parameters</table>
27
27
  <p>Example Usage:</p>
28
- <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash 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">--</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"cmd"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST COLLECT with DURATION 1.0, TEMP 0.0, TYPE 'NORMAL'"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</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" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><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 operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"cmd"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</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" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></span></code></pre></div></div>
29
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=getting-telemetry>Getting Telemetry<a href=#getting-telemetry class=hash-link aria-label="Direct link to Getting Telemetry" title="Direct link to Getting Telemetry">​</a></h3>
28
+ <div class="language-bash codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-bash codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">--</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"cmd"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST COLLECT with DURATION 1.0, TEMP 0.0, TYPE 'NORMAL'"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</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" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><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 operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"cmd"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</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" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"COLLECT"</span><span class="token plain">, </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"DURATION"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.0</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TYPE"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"NORMAL"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br/></span></code></pre></div></div>
29
+ <h3 class="anchor anchorWithStickyNavbar_TUrh" id=getting-telemetry>Getting Telemetry<a href=#getting-telemetry class=hash-link aria-label="Direct link to Getting Telemetry" title="Direct link to Getting Telemetry" translate=no>​</a></h3>
30
30
  <p>The following methods are used to get telemetry: tlm, tlm_raw, tlm_formatted, tlm_with_units</p>
31
31
  <p>The tlm method returns the current converted value of a telemetry point. The tlm_raw method returns the current raw value of a telemetry point. The tlm_formatted method returns the current formatted value of a telemetry point. The tlm_with_units method returns the current formatted value of a telemetry point with its units appended to the end.</p>
32
32
  <p>Two parameter syntaxes are supported.</p>
@@ -35,8 +35,8 @@
35
35
  <p>The second is three parameters with the first parameter being a string denoting the target name, the second being a string with the packet name, and the third being a string with the item name.</p>
36
36
  <table><thead><tr><th>Parameter<th>Data Type<th>Description<tbody><tr><td>target_name<td>String<td>Name of the target to get the telemetry value from<tr><td>packet_name<td>String<td>Name of the packet to get the telemetry value from<tr><td>item_name<td>String<td>Name of the telemetry item</table>
37
37
  <p>Example Usage:</p>
38
- <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash 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">--</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"tlm"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST HEALTH_STATUS TEMP1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">94.9438</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</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 operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"tlm"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"HEALTH_STATUS"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">94.9438</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></span></code></pre></div></div>
39
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=further-debugging>Further Debugging<a href=#further-debugging class=hash-link aria-label="Direct link to Further Debugging" title="Direct link to Further Debugging">​</a></h2>
38
+ <div class="language-bash codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-bash codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">--</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"tlm"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST HEALTH_STATUS TEMP1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">94.9438</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</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 operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"method"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"tlm"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"params"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"INST"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"HEALTH_STATUS"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"TEMP1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"keyword_params"</span><span class="token plain">:</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"scope"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token string" style="color:rgb(173, 219, 103)">"DEFAULT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">-- </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string" style="color:rgb(173, 219, 103)">"jsonrpc"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"2.0"</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"result"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">94.9438</span><span class="token plain">, </span><span class="token string" style="color:rgb(173, 219, 103)">"id"</span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br/></span></code></pre></div></div>
39
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=further-debugging>Further Debugging<a href=#further-debugging class=hash-link aria-label="Direct link to Further Debugging" title="Direct link to Further Debugging" translate=no>​</a></h2>
40
40
  <p>If developing an interface for the JSON API from another language, the best way to debug is to send the same messages from the supported Ruby interface first, like the following. By enabling the debug mode, you can see the exact request and response sent from the Ruby Implementation.</p>
41
41
  <ol>
42
42
  <li>Launch COSMOS</li>
@@ -47,4 +47,4 @@
47
47
  <li>View the request in the developer tool. Click the "Payload" sub-tab to view the JSON</li>
48
48
  </ol>
49
49
  <p>You can also try sending these raw commands from the terminal with a program like <code>curl</code>:</p>
50
- <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function" style="color:rgb(130, 170, 255)">curl</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-d</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'{"jsonrpc": "2.0", "method": "tlm", "params": ["INST HEALTH_STATUS TEMP1"], "id": 2, "keyword_params":{"type":"WITH_UNITS","scope":"DEFAULT"}}'</span><span class="token plain"> http://localhost:2900/openc3-api/api </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-H</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"Authorization: password"</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/json-api.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/developing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Developing COSMOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/log-structure><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Log Structure</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=#authorization class="table-of-contents__link toc-highlight">Authorization</a><li><a href=#json-rpc-20 class="table-of-contents__link toc-highlight">JSON-RPC 2.0</a><li><a href=#socket-connections class="table-of-contents__link toc-highlight">Socket Connections</a><li><a href=#supported-methods class="table-of-contents__link toc-highlight">Supported Methods</a><li><a href=#existing-implementations class="table-of-contents__link toc-highlight">Existing Implementations</a><li><a href=#example-usage class="table-of-contents__link toc-highlight">Example Usage</a><ul><li><a href=#sending-commands class="table-of-contents__link toc-highlight">Sending Commands</a><li><a href=#getting-telemetry class="table-of-contents__link toc-highlight">Getting Telemetry</a></ul><li><a href=#further-debugging class="table-of-contents__link toc-highlight">Further Debugging</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
50
+ <div class="language-bash codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-bash codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token function" style="color:rgb(130, 170, 255)">curl</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-d</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'{"jsonrpc": "2.0", "method": "tlm", "params": ["INST HEALTH_STATUS TEMP1"], "id": 2, "keyword_params":{"type":"WITH_UNITS","scope":"DEFAULT"}}'</span><span class="token plain"> http://localhost:2900/openc3-api/api </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-H</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"Authorization: password"</span><br/></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/json-api.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_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/developing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Developing COSMOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/log-structure><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Log Structure</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#authorization class="table-of-contents__link toc-highlight">Authorization</a><li><a href=#json-rpc-20 class="table-of-contents__link toc-highlight">JSON-RPC 2.0</a><li><a href=#socket-connections class="table-of-contents__link toc-highlight">Socket Connections</a><li><a href=#supported-methods class="table-of-contents__link toc-highlight">Supported Methods</a><li><a href=#existing-implementations class="table-of-contents__link toc-highlight">Existing Implementations</a><li><a href=#example-usage class="table-of-contents__link toc-highlight">Example Usage</a><ul><li><a href=#sending-commands class="table-of-contents__link toc-highlight">Sending Commands</a><li><a href=#getting-telemetry class="table-of-contents__link toc-highlight">Getting Telemetry</a></ul><li><a href=#further-debugging class="table-of-contents__link toc-highlight">Further Debugging</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
@@ -1,29 +1,29 @@
1
- <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/log-structure" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Log Structure | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure><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="Log Structure | OpenC3 Docs"><meta data-rh=true name=description content="Structure of the COSMOS log file"><meta data-rh=true property=og:description content="Structure of the COSMOS log file"><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/development/log-structure><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/log-structure","name":"Log Structure","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.0edf3032.css><script src=/tools/staticdocs/assets/js/runtime~main.44311138.js defer></script><script src=/tools/staticdocs/assets/js/main.994f9f74.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/log-structure" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Log Structure | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure /><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="Log Structure | OpenC3 Docs"/><meta data-rh=true name=description content="Structure of the COSMOS log file"/><meta data-rh=true property=og:description content="Structure of the COSMOS log file"/><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/development/log-structure /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/log-structure hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/log-structure","name":"Log Structure","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
2
2
  <symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
3
3
  </defs></svg>
4
- <script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl>Testing with Curl</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing>Developing COSMOS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/json-api>JSON API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/log-structure>Log Structure</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/roadmap>Roadmap</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api>Streaming API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing>Testing COSMOS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Log Structure</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Log Structure</h1></header><p>Updated: 8-21-2023 to the format as of OpenC3 COSMOS 5.11.0</p>
5
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=packet-log-file-format>Packet Log File Format<a href=#packet-log-file-format class=hash-link aria-label="Direct link to Packet Log File Format" title="Direct link to Packet Log File Format">​</a></h2>
4
+ <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><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><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl><span title="Testing with Curl" class=linkLabel_THKR>Testing with Curl</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing><span title="Developing COSMOS" class=linkLabel_THKR>Developing COSMOS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/json-api><span title="JSON API" class=linkLabel_THKR>JSON API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/log-structure><span title="Log Structure" class=linkLabel_THKR>Log Structure</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/roadmap><span title=Roadmap class=linkLabel_THKR>Roadmap</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api><span title="Streaming API" class=linkLabel_THKR>Streaming API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing><span title="Testing COSMOS" class=linkLabel_THKR>Testing COSMOS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Log Structure</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Log Structure</h1></header><p>Updated: 8-21-2023 to the format as of OpenC3 COSMOS 5.11.0</p>
5
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=packet-log-file-format>Packet Log File Format<a href=#packet-log-file-format class=hash-link aria-label="Direct link to Packet Log File Format" title="Direct link to Packet Log File Format" translate=no>​</a></h2>
6
6
  <p>Packet logs in OpenC3 COSMOS 5 are used to store raw binary packets as received from various targets, as
7
7
  well as decommutated packets stored as JSON structures.</p>
8
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=file-header>File Header<a href=#file-header class=hash-link aria-label="Direct link to File Header" title="Direct link to File Header">​</a></h3>
8
+ <h3 class="anchor anchorWithStickyNavbar_TUrh" id=file-header>File Header<a href=#file-header class=hash-link aria-label="Direct link to File Header" title="Direct link to File Header" translate=no>​</a></h3>
9
9
  <p>COSMOS 5 Packet log files start with the 8-character sequence "COSMOS5_". This can be used to identify the type of file independent of filename and differentiate them from newer and older versions.</p>
10
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=entry-types>Entry Types<a href=#entry-types class=hash-link aria-label="Direct link to Entry Types" title="Direct link to Entry Types">​</a></h3>
10
+ <h3 class="anchor anchorWithStickyNavbar_TUrh" id=entry-types>Entry Types<a href=#entry-types class=hash-link aria-label="Direct link to Entry Types" title="Direct link to Entry Types" translate=no>​</a></h3>
11
11
  <p>Packet log files have 6 different entry types with room for future expansion. All entry headers are big endian binary data.</p>
12
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=common-entry-format>Common Entry Format<a href=#common-entry-format class=hash-link aria-label="Direct link to Common Entry Format" title="Direct link to Common Entry Format">​</a></h4>
12
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=common-entry-format>Common Entry Format<a href=#common-entry-format class=hash-link aria-label="Direct link to Common Entry Format" title="Direct link to Common Entry Format" translate=no>​</a></h4>
13
13
  <p>This common format is used for all packet log entries:</p>
14
- <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Length<td>32-bit Unsigned Integer<td>Total length of the entry in bytes not including the length field. Max entry size is therefore 4GiB.<tr><td>Entry Type<td>4-bit Unsigned Integer<td>Entry Type:<br>1 = Target Declaration<br>2 = Packet Declaraction<br>3 = Raw Packet<br>4 = JSON/CBOR Packet<br>5 = Offset Marker<br>6 = Key Map<tr><td>Cmd/Tlm Flag<td>1-bit Unsigned Integer<td>1 = Command<br>0 = Telemetry<tr><td>Stored Flag<td>1-bit Unsigned Integer<td>1 = Stored Data<br>0 = Realtime Data<tr><td>Id Flag<td>1-bit Unsigned Integer<td>1 = ID present<br>0 = ID not present<tr><td>CBOR Flag<td>1-bit Unsigned Integer<td>Only Valid for "JSON/CBOR Packets"<br>1 = CBOR Data<br>0 = JSON Data<tr><td>Extra Flag<td>1-bit Unsigned Integer<td>1 = Extra present<br>0 = Extra Not Present (Added COSMOS 5.11)<tr><td>Received Time Flag<td>1-bit Unsigned Integer<td>1 = Received Time Present<br>0 = No Received Time (Added COSMOS 5.11.0)<tr><td>Reserved<td>6-bit Unsigned Integer<td>Reserved for Future expansion. Should be set to 0 if unused.<tr><td>Entry Data<td>Variable<td>Unique data based on entry type. See Entry Types Below<tr><td>Id (Optional)<td>32-byte Binary Hash<td>If the ID field is set, this is a binary 256-bit SHA-256 hash uniquely identifying a target configuration or packet configuration</table>
15
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=target-declaration-entry>Target Declaration Entry<a href=#target-declaration-entry class=hash-link aria-label="Direct link to Target Declaration Entry" title="Direct link to Target Declaration Entry">​</a></h4>
14
+ <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Length<td>32-bit Unsigned Integer<td>Total length of the entry in bytes not including the length field. Max entry size is therefore 4GiB.<tr><td>Entry Type<td>4-bit Unsigned Integer<td>Entry Type:<br/>1 = Target Declaration<br/>2 = Packet Declaraction<br/>3 = Raw Packet<br/>4 = JSON/CBOR Packet<br/>5 = Offset Marker<br/>6 = Key Map<tr><td>Cmd/Tlm Flag<td>1-bit Unsigned Integer<td>1 = Command<br/>0 = Telemetry<tr><td>Stored Flag<td>1-bit Unsigned Integer<td>1 = Stored Data<br/>0 = Realtime Data<tr><td>Id Flag<td>1-bit Unsigned Integer<td>1 = ID present<br/>0 = ID not present<tr><td>CBOR Flag<td>1-bit Unsigned Integer<td>Only Valid for "JSON/CBOR Packets"<br/>1 = CBOR Data<br/>0 = JSON Data<tr><td>Extra Flag<td>1-bit Unsigned Integer<td>1 = Extra present<br/>0 = Extra Not Present (Added COSMOS 5.11)<tr><td>Received Time Flag<td>1-bit Unsigned Integer<td>1 = Received Time Present<br/>0 = No Received Time (Added COSMOS 5.11.0)<tr><td>Reserved<td>6-bit Unsigned Integer<td>Reserved for Future expansion. Should be set to 0 if unused.<tr><td>Entry Data<td>Variable<td>Unique data based on entry type. See Entry Types Below<tr><td>Id (Optional)<td>32-byte Binary Hash<td>If the ID field is set, this is a binary 256-bit SHA-256 hash uniquely identifying a target configuration or packet configuration</table>
15
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=target-declaration-entry>Target Declaration Entry<a href=#target-declaration-entry class=hash-link aria-label="Direct link to Target Declaration Entry" title="Direct link to Target Declaration Entry" translate=no>​</a></h4>
16
16
  <p>Declares the name of a target the first time it is seen when writing the log file.</p>
17
17
  <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Target Name<td>Variable-Length ASCII String<td>Target Name</table>
18
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=packet-declaration-entry>Packet Declaration Entry<a href=#packet-declaration-entry class=hash-link aria-label="Direct link to Packet Declaration Entry" title="Direct link to Packet Declaration Entry">​</a></h4>
18
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=packet-declaration-entry>Packet Declaration Entry<a href=#packet-declaration-entry class=hash-link aria-label="Direct link to Packet Declaration Entry" title="Direct link to Packet Declaration Entry" translate=no>​</a></h4>
19
19
  <p>Declares the name of a packet the first time it is seen when writing the log file. References the associated target name by index.</p>
20
20
  <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Target Index<td>16-bit Unsigned Integer<td>Index into a dynamically built table of target names, generated from the order of the target declarations in the file. The first target declaration gets index 0, the second target declaration gets index 1, etc.<tr><td>Packet Name<td>Variable-Length ASCII String<td>Packet Name</table>
21
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=raw-packet-and-json-packet-entries>Raw Packet and JSON Packet Entries<a href=#raw-packet-and-json-packet-entries class=hash-link aria-label="Direct link to Raw Packet and JSON Packet Entries" title="Direct link to Raw Packet and JSON Packet Entries">​</a></h4>
21
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=raw-packet-and-json-packet-entries>Raw Packet and JSON Packet Entries<a href=#raw-packet-and-json-packet-entries class=hash-link aria-label="Direct link to Raw Packet and JSON Packet Entries" title="Direct link to Raw Packet and JSON Packet Entries" translate=no>​</a></h4>
22
22
  <p>Holds the main data for a packet. Raw packets are the data before the COSMOS decommutation phase. "JSON" packets are the data after decommutation. Note that "JSON" packets are now generally stored as CBOR rather than JSON to reduce storage size.</p>
23
23
  <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Packet Index<td>16-bit Unsigned Integer<td>Index into a dynamically built table of cmd_or_tlm/target name/packet name tuples, generated from the order of the packet declarations in the file. The first packet declaration gets index 0, the second packet declaration gets index 1, etc. This limits the max number of unique packet types in a single file to 65536.<tr><td>Packet Timestamp<td>64-bit Unsigned Integer<td>Packet timestamp in nanoseconds from the unix epoch (Jan 1st, 1970, midnight). This field contains the “packet time” for both Raw and JSON packet entries (which are used to store decommutated date). For JSON packet entries, the packet received time can also be extracted from the JSON data if needed.<tr><td>Received Timestamp (Optional)<td>64-bit Unsigned Integer<td>Only present if Received Time Flag is Set (Only currently in Raw log files). Received timestamp in nanoseconds from the unix epoch (Jan 1st, 1970, midnight). This field contains the received time” for both Raw packet entries (which are used to store decommutated date). For JSON packet entries, the packet received time can be extracted from the JSON data if needed.<tr><td>Extra Length (Optional)<td>32-bit Unsigned Integer<td>Only Present if Extra Flag is Set. Length of extra data in bytes not including itself.<tr><td>Extra Data (Optional)<td>Variable-Length Block Data<td>Only Present if Extra Flag is Set. CBOR or JSON encoded object of extra data.<tr><td>Packet Data<td>Variable-Length Block Data<td>The Raw binary packet data for Raw Packet entries, and ASCII JSON data (or CBOR if flag set) for JSON packet entries. Note the Common Entry Format Id field is not supported with either type of packet entry.</table>
24
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=offset-marker-entry>Offset Marker Entry<a href=#offset-marker-entry class=hash-link aria-label="Direct link to Offset Marker Entry" title="Direct link to Offset Marker Entry">​</a></h4>
24
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=offset-marker-entry>Offset Marker Entry<a href=#offset-marker-entry class=hash-link aria-label="Direct link to Offset Marker Entry" title="Direct link to Offset Marker Entry" translate=no>​</a></h4>
25
25
  <p>This contains the Redis stream offset for the last packet stored in this log file. This entry allows for a seamless transition from log files to Redis streams holding the most recent data received by COSMOS.</p>
26
26
  <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Offset Marker<td>Variable-Length ASCII String<td>Redis Offset Marker</table>
27
- <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=key-map-entry>Key Map Entry<a href=#key-map-entry class=hash-link aria-label="Direct link to Key Map Entry" title="Direct link to Key Map Entry">​</a></h4>
27
+ <h4 class="anchor anchorWithStickyNavbar_TUrh" id=key-map-entry>Key Map Entry<a href=#key-map-entry class=hash-link aria-label="Direct link to Key Map Entry" title="Direct link to Key Map Entry" translate=no>​</a></h4>
28
28
  <p>The key map entry is used to further reduce log file sizes by reducing the size of the names of the decommutated values. Each value is given a numeric name counting up from 0 which drastically reduces decommutated data size. Note: This could be further enhanced in the future by changing to a denser encoding similar to base64. The key map is generated on the first reception of a packet. If future packets have different keys, then the names are used as-is and no reduction is gained. Typically packet keys don't change within a file.</p>
29
- <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Packet Index<td>16-bit Unsigned Integer<td>Index into a dynamically built table of packet names, generated from the order of the packet declarations in the file. The first packet declaration gets index 0, the second packet declaration gets index 1, etc.<tr><td>Key Map<td>Variable-Length ASCII String<td>Key Map Data with Mapping from numeric key to actual packet item name</table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/log-structure.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/json-api><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>JSON API</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/roadmap><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Roadmap</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=#packet-log-file-format class="table-of-contents__link toc-highlight">Packet Log File Format</a><ul><li><a href=#file-header class="table-of-contents__link toc-highlight">File Header</a><li><a href=#entry-types class="table-of-contents__link toc-highlight">Entry Types</a><ul><li><a href=#common-entry-format class="table-of-contents__link toc-highlight">Common Entry Format</a><li><a href=#target-declaration-entry class="table-of-contents__link toc-highlight">Target Declaration Entry</a><li><a href=#packet-declaration-entry class="table-of-contents__link toc-highlight">Packet Declaration Entry</a><li><a href=#raw-packet-and-json-packet-entries class="table-of-contents__link toc-highlight">Raw Packet and JSON Packet Entries</a><li><a href=#offset-marker-entry class="table-of-contents__link toc-highlight">Offset Marker Entry</a><li><a href=#key-map-entry class="table-of-contents__link toc-highlight">Key Map Entry</a></ul></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
29
+ <table><thead><tr><th>Field<th>Data Type<th>Description<tbody><tr><td>Packet Index<td>16-bit Unsigned Integer<td>Index into a dynamically built table of packet names, generated from the order of the packet declarations in the file. The first packet declaration gets index 0, the second packet declaration gets index 1, etc.<tr><td>Key Map<td>Variable-Length ASCII String<td>Key Map Data with Mapping from numeric key to actual packet item name</table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/log-structure.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_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/json-api><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>JSON API</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/roadmap><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Roadmap</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#packet-log-file-format class="table-of-contents__link toc-highlight">Packet Log File Format</a><ul><li><a href=#file-header class="table-of-contents__link toc-highlight">File Header</a><li><a href=#entry-types class="table-of-contents__link toc-highlight">Entry Types</a><ul><li><a href=#common-entry-format class="table-of-contents__link toc-highlight">Common Entry Format</a><li><a href=#target-declaration-entry class="table-of-contents__link toc-highlight">Target Declaration Entry</a><li><a href=#packet-declaration-entry class="table-of-contents__link toc-highlight">Packet Declaration Entry</a><li><a href=#raw-packet-and-json-packet-entries class="table-of-contents__link toc-highlight">Raw Packet and JSON Packet Entries</a><li><a href=#offset-marker-entry class="table-of-contents__link toc-highlight">Offset Marker Entry</a><li><a href=#key-map-entry class="table-of-contents__link toc-highlight">Key Map Entry</a></ul></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
@@ -1,7 +1,7 @@
1
- <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/roadmap" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Roadmap | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap><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="Roadmap | OpenC3 Docs"><meta data-rh=true name=description content="COSMOS roadmap now and into the future"><meta data-rh=true property=og:description content="COSMOS roadmap now and into the future"><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/development/roadmap><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/roadmap","name":"Roadmap","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.0edf3032.css><script src=/tools/staticdocs/assets/js/runtime~main.44311138.js defer></script><script src=/tools/staticdocs/assets/js/main.994f9f74.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-development/roadmap" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Roadmap | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap /><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="Roadmap | OpenC3 Docs"/><meta data-rh=true name=description content="COSMOS roadmap now and into the future"/><meta data-rh=true property=og:description content="COSMOS roadmap now and into the future"/><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/development/roadmap /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development/roadmap hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development","name":"Development","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/development/roadmap","name":"Roadmap","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
2
2
  <symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
3
3
  </defs></svg>
4
- <script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl>Testing with Curl</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing>Developing COSMOS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/json-api>JSON API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/log-structure>Log Structure</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/roadmap>Roadmap</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api>Streaming API</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing>Testing COSMOS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Roadmap</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Roadmap</h1></header><p>Please read the release notes on the <a href=https://github.com/OpenC3/cosmos/releases target=_blank rel="noopener noreferrer">Releases</a> page to learn about current functionality.</p>
4
+ <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><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><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Collapse sidebar category 'Development'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/curl><span title="Testing with Curl" class=linkLabel_THKR>Testing with Curl</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/developing><span title="Developing COSMOS" class=linkLabel_THKR>Developing COSMOS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/json-api><span title="JSON API" class=linkLabel_THKR>JSON API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/log-structure><span title="Log Structure" class=linkLabel_THKR>Log Structure</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/development/roadmap><span title=Roadmap class=linkLabel_THKR>Roadmap</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/streaming-api><span title="Streaming API" class=linkLabel_THKR>Streaming API</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/development/testing><span title="Testing COSMOS" class=linkLabel_THKR>Testing COSMOS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/development><span>Development</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Roadmap</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Roadmap</h1></header><p>Please read the release notes on the <a href=https://github.com/OpenC3/cosmos/releases target=_blank rel="noopener noreferrer">Releases</a> page to learn about current functionality.</p>
5
5
  <p>Our roadmap is captured via Github <a href=https://github.com/OpenC3/cosmos/milestones target=_blank rel="noopener noreferrer">Milestones</a>. We have major milestones (6.0, 7.0, etc) and minor milestones (6.x, 7.x, etc) that incorporate new functionality, enhancements, bug fixes, and dependency updates. Note that we also release patch releases (6.5.1) that incorporate only minor enhancements, bug fixes, and dependency updates but these are not milestoned.</p>
6
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=github-issues>Github Issues<a href=#github-issues class=hash-link aria-label="Direct link to Github Issues" title="Direct link to Github Issues">​</a></h2>
7
- <p>We prioritize bugs and customer requests in our Github <a href=https://github.com/OpenC3/cosmos/issues target=_blank rel="noopener noreferrer">issues</a> list. If you're an OpenC3 customer, please reach out at <a href=mailto:support@openc3.com target=_blank rel="noopener noreferrer">support@openc3.com</a> and let us know what issues you need prioritized.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/roadmap.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/log-structure><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Log Structure</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/streaming-api><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Streaming API</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=#github-issues class="table-of-contents__link toc-highlight">Github Issues</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
6
+ <h2 class="anchor anchorWithStickyNavbar_TUrh" id=github-issues>Github Issues<a href=#github-issues class=hash-link aria-label="Direct link to Github Issues" title="Direct link to Github Issues" translate=no>​</a></h2>
7
+ <p>We prioritize bugs and customer requests in our Github <a href=https://github.com/OpenC3/cosmos/issues target=_blank rel="noopener noreferrer">issues</a> list. If you're an OpenC3 customer, please reach out at <a href=mailto:support@openc3.com target=_blank rel="noopener noreferrer">support@openc3.com</a> and let us know what issues you need prioritized.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/roadmap.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_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/development/log-structure><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Log Structure</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/streaming-api><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Streaming API</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#github-issues class="table-of-contents__link toc-highlight">Github Issues</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>