openc3-cosmos-tool-docs 6.5.1 → 6.7.0

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 (240) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +1 -1
  3. data/tools/staticdocs/assets/css/{styles.1a361da6.css → styles.3a94737c.css} +1 -1
  4. data/tools/staticdocs/assets/js/019369f3.aee00d57.js +1 -0
  5. data/tools/staticdocs/assets/js/058ffc22.4303e204.js +1 -0
  6. data/tools/staticdocs/assets/js/0686a885.be701f94.js +1 -0
  7. data/tools/staticdocs/assets/js/{078dbab0.babf69ab.js → 078dbab0.e6fc6dd3.js} +1 -1
  8. data/tools/staticdocs/assets/js/0f5d161c.a79a923a.js +1 -0
  9. data/tools/staticdocs/assets/js/{0ff569c9.14ed0a79.js → 0ff569c9.9c143528.js} +1 -1
  10. data/tools/staticdocs/assets/js/103cc3be.37e9dfb2.js +1 -0
  11. data/tools/staticdocs/assets/js/13196248.21d79b91.js +1 -0
  12. data/tools/staticdocs/assets/js/13c1b4e4.91618ec1.js +1 -0
  13. data/tools/staticdocs/assets/js/1836.1d45ff5f.js +1 -0
  14. data/tools/staticdocs/assets/js/1e02e6a3.600ebf22.js +1 -0
  15. data/tools/staticdocs/assets/js/2047b354.50c117b3.js +1 -0
  16. data/tools/staticdocs/assets/js/2124.c8b95b39.js +1 -0
  17. data/tools/staticdocs/assets/js/22b3ac48.cfbc9c82.js +1 -0
  18. data/tools/staticdocs/assets/js/2368.071909f8.js +4 -0
  19. data/tools/staticdocs/assets/js/2bb7bf90.44f29c21.js +1 -0
  20. data/tools/staticdocs/assets/js/2c15ad40.d1ffefde.js +1 -0
  21. data/tools/staticdocs/assets/js/35398c5c.431a9dcc.js +1 -0
  22. data/tools/staticdocs/assets/js/{3687.0a024e4c.js → 3687.0184c4bd.js} +2 -2
  23. data/tools/staticdocs/assets/js/3dd7ef3b.bd26614f.js +1 -0
  24. data/tools/staticdocs/assets/js/40365d27.19107461.js +1 -0
  25. data/tools/staticdocs/assets/js/411898ad.91b73850.js +1 -0
  26. data/tools/staticdocs/assets/js/42170351.082207e5.js +1 -0
  27. data/tools/staticdocs/assets/js/43652efd.f076a420.js +1 -0
  28. data/tools/staticdocs/assets/js/5074.11914a81.js +1 -0
  29. data/tools/staticdocs/assets/js/54d0d530.9ad6d6ad.js +1 -0
  30. data/tools/staticdocs/assets/js/59ed27a4.e9ab6f6b.js +1 -0
  31. data/tools/staticdocs/assets/js/5b233ba7.085f41a9.js +1 -0
  32. data/tools/staticdocs/assets/js/5bc719f6.2b490409.js +1 -0
  33. data/tools/staticdocs/assets/js/5c6ce5ec.1cf87b97.js +1 -0
  34. data/tools/staticdocs/assets/js/5e3ed378.92ac2561.js +1 -0
  35. data/tools/staticdocs/assets/js/5fe211ef.aa0ccb3b.js +1 -0
  36. data/tools/staticdocs/assets/js/{630e5448.699a9dec.js → 630e5448.db32449b.js} +1 -1
  37. data/tools/staticdocs/assets/js/6831b732.bb545e9e.js +1 -0
  38. data/tools/staticdocs/assets/js/696b4199.f976483f.js +1 -0
  39. data/tools/staticdocs/assets/js/6b210247.71cd015b.js +1 -0
  40. data/tools/staticdocs/assets/js/6b65133b.9c1a2ea5.js +1 -0
  41. data/tools/staticdocs/assets/js/6f92e431.acc724a9.js +1 -0
  42. data/tools/staticdocs/assets/js/72c6d8a8.f72c7c50.js +1 -0
  43. data/tools/staticdocs/assets/js/75e64983.f1731ba5.js +1 -0
  44. data/tools/staticdocs/assets/js/80c97f38.b5528d51.js +1 -0
  45. data/tools/staticdocs/assets/js/867640d5.a5ebb584.js +1 -0
  46. data/tools/staticdocs/assets/js/89e76475.6f1bd0e6.js +1 -0
  47. data/tools/staticdocs/assets/js/8b939c74.bb6669b6.js +1 -0
  48. data/tools/staticdocs/assets/js/8f7843ee.56210187.js +1 -0
  49. data/tools/staticdocs/assets/js/9424f0b3.4d21b90c.js +1 -0
  50. data/tools/staticdocs/assets/js/964eb012.7b1d7e91.js +1 -0
  51. data/tools/staticdocs/assets/js/97535711.ba627d0c.js +1 -0
  52. data/tools/staticdocs/assets/js/99581c43.f64fd445.js +1 -0
  53. data/tools/staticdocs/assets/js/9d6e81d0.c58de1b0.js +1 -0
  54. data/tools/staticdocs/assets/js/{9fb6059a.91edfcba.js → 9fb6059a.f48e20dc.js} +1 -1
  55. data/tools/staticdocs/assets/js/a677c089.6178ef83.js +1 -0
  56. data/tools/staticdocs/assets/js/a9987364.0d275743.js +1 -0
  57. data/tools/staticdocs/assets/js/a9b2dc27.b072fff7.js +1 -0
  58. data/tools/staticdocs/assets/js/aa6b6c1b.a3594c17.js +1 -0
  59. data/tools/staticdocs/assets/js/b062d239.96a0a741.js +1 -0
  60. data/tools/staticdocs/assets/js/b38a6d74.9f9ebdb2.js +1 -0
  61. data/tools/staticdocs/assets/js/b4596165.8f48aec1.js +1 -0
  62. data/tools/staticdocs/assets/js/b6d70f94.16ef1b69.js +1 -0
  63. data/tools/staticdocs/assets/js/b9f60ba6.df189198.js +1 -0
  64. data/tools/staticdocs/assets/js/bd0034eb.005cb7d6.js +1 -0
  65. data/tools/staticdocs/assets/js/c24eae19.052a322f.js +1 -0
  66. data/tools/staticdocs/assets/js/cb8c3f08.989b1a52.js +1 -0
  67. data/tools/staticdocs/assets/js/cd879be4.3ca90941.js +1 -0
  68. data/tools/staticdocs/assets/js/cf1c01b8.421b8b4b.js +1 -0
  69. data/tools/staticdocs/assets/js/d1b923aa.5b892530.js +1 -0
  70. data/tools/staticdocs/assets/js/d1bfc316.0670c343.js +1 -0
  71. data/tools/staticdocs/assets/js/{d24bf9b6.ea1e95ab.js → d24bf9b6.2db3594a.js} +1 -1
  72. data/tools/staticdocs/assets/js/d57a4b5d.dd2f0a5d.js +1 -0
  73. data/tools/staticdocs/assets/js/d5d77c37.3fe16a67.js +1 -0
  74. data/tools/staticdocs/assets/js/{d66bf9c0.8018f0a0.js → d66bf9c0.4216f492.js} +1 -1
  75. data/tools/staticdocs/assets/js/d8ca4191.0bdab1a3.js +1 -0
  76. data/tools/staticdocs/assets/js/d9b92eba.3909c726.js +1 -0
  77. data/tools/staticdocs/assets/js/db8fa1d0.416dbe98.js +1 -0
  78. data/tools/staticdocs/assets/js/dbe31111.da0777f1.js +1 -0
  79. data/tools/staticdocs/assets/js/dc5f7beb.bc79c9f5.js +1 -0
  80. data/tools/staticdocs/assets/js/e501b0d1.732c5ad4.js +1 -0
  81. data/tools/staticdocs/assets/js/f15615f1.6a937fc3.js +1 -0
  82. data/tools/staticdocs/assets/js/{f75a5f33.d3a97a44.js → f75a5f33.cdf29c46.js} +1 -1
  83. data/tools/staticdocs/assets/js/fd886806.833fb1cc.js +1 -0
  84. data/tools/staticdocs/assets/js/main.8b65f76b.js +38 -0
  85. data/tools/staticdocs/assets/js/runtime~main.ff5e0de8.js +1 -0
  86. data/tools/staticdocs/docs/configuration/accessors.html +2 -2
  87. data/tools/staticdocs/docs/configuration/command.html +18 -17
  88. data/tools/staticdocs/docs/configuration/conversions.html +22 -65
  89. data/tools/staticdocs/docs/configuration/format.html +1 -1
  90. data/tools/staticdocs/docs/configuration/interfaces.html +22 -47
  91. data/tools/staticdocs/docs/configuration/limits-response.html +1 -1
  92. data/tools/staticdocs/docs/configuration/plugins.html +7 -25
  93. data/tools/staticdocs/docs/configuration/processors.html +3 -9
  94. data/tools/staticdocs/docs/configuration/protocols.html +46 -54
  95. data/tools/staticdocs/docs/configuration/ssl-tls.html +1 -1
  96. data/tools/staticdocs/docs/configuration/table.html +7 -11
  97. data/tools/staticdocs/docs/configuration/target.html +1 -1
  98. data/tools/staticdocs/docs/configuration/telemetry-screens.html +2 -2
  99. data/tools/staticdocs/docs/configuration/telemetry.html +12 -25
  100. data/tools/staticdocs/docs/configuration.html +1 -1
  101. data/tools/staticdocs/docs/development/curl.html +1 -1
  102. data/tools/staticdocs/docs/development/developing.html +3 -3
  103. data/tools/staticdocs/docs/development/json-api.html +1 -1
  104. data/tools/staticdocs/docs/development/log-structure.html +1 -1
  105. data/tools/staticdocs/docs/development/roadmap.html +1 -1
  106. data/tools/staticdocs/docs/development/streaming-api.html +2 -2
  107. data/tools/staticdocs/docs/development/testing.html +1 -1
  108. data/tools/staticdocs/docs/development.html +2 -2
  109. data/tools/staticdocs/docs/getting-started/cli.html +9 -4
  110. data/tools/staticdocs/docs/getting-started/generators.html +2 -2
  111. data/tools/staticdocs/docs/getting-started/gettingstarted.html +4 -4
  112. data/tools/staticdocs/docs/getting-started/installation.html +4 -6
  113. data/tools/staticdocs/docs/getting-started/key-concepts.html +1 -1
  114. data/tools/staticdocs/docs/getting-started/podman.html +7 -2
  115. data/tools/staticdocs/docs/getting-started/requirements.html +1 -1
  116. data/tools/staticdocs/docs/getting-started/upgrading.html +27 -15
  117. data/tools/staticdocs/docs/getting-started.html +1 -1
  118. data/tools/staticdocs/docs/guides/bridges.html +2 -2
  119. data/tools/staticdocs/docs/guides/cfs.html +3 -3
  120. data/tools/staticdocs/docs/guides/custom-widgets.html +2 -2
  121. data/tools/staticdocs/docs/guides/dynamic-packets.html +2 -2
  122. data/tools/staticdocs/docs/guides/exposing-microservices.html +8 -8
  123. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +2 -2
  124. data/tools/staticdocs/docs/guides/local-mode.html +2 -2
  125. data/tools/staticdocs/docs/guides/logging.html +2 -2
  126. data/tools/staticdocs/docs/guides/monitoring.html +2 -2
  127. data/tools/staticdocs/docs/guides/performance.html +2 -2
  128. data/tools/staticdocs/docs/guides/raspberrypi.html +2 -2
  129. data/tools/staticdocs/docs/guides/reference-architectures.html +2 -2
  130. data/tools/staticdocs/docs/guides/script-writing.html +3 -6
  131. data/tools/staticdocs/docs/guides/scripting-api.html +377 -996
  132. data/tools/staticdocs/docs/guides/troubleshooting.html +54 -0
  133. data/tools/staticdocs/docs/guides.html +2 -2
  134. data/tools/staticdocs/docs/meta/contributing.html +1 -1
  135. data/tools/staticdocs/docs/meta/licenses.html +1 -1
  136. data/tools/staticdocs/docs/meta/philosophy.html +1 -1
  137. data/tools/staticdocs/docs/meta/xtce.html +1 -1
  138. data/tools/staticdocs/docs/meta.html +1 -1
  139. data/tools/staticdocs/docs/privacy.html +1 -1
  140. data/tools/staticdocs/docs/tools/admin.html +1 -1
  141. data/tools/staticdocs/docs/tools/autonomic.html +1 -1
  142. data/tools/staticdocs/docs/tools/bucket-explorer.html +1 -1
  143. data/tools/staticdocs/docs/tools/calendar.html +1 -1
  144. data/tools/staticdocs/docs/tools/cmd-sender.html +1 -1
  145. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +3 -6
  146. data/tools/staticdocs/docs/tools/command_history.html +1 -1
  147. data/tools/staticdocs/docs/tools/data-extractor.html +1 -1
  148. data/tools/staticdocs/docs/tools/data-viewer.html +1 -1
  149. data/tools/staticdocs/docs/tools/handbooks.html +1 -1
  150. data/tools/staticdocs/docs/tools/limits-monitor.html +1 -1
  151. data/tools/staticdocs/docs/tools/packet-viewer.html +1 -1
  152. data/tools/staticdocs/docs/tools/script-runner.html +1 -1
  153. data/tools/staticdocs/docs/tools/systemhealth.html +1 -1
  154. data/tools/staticdocs/docs/tools/table-manager.html +1 -1
  155. data/tools/staticdocs/docs/tools/tlm-grapher.html +1 -1
  156. data/tools/staticdocs/docs/tools/tlm-viewer.html +1 -1
  157. data/tools/staticdocs/docs/tools.html +1 -1
  158. data/tools/staticdocs/docs.html +1 -1
  159. data/tools/staticdocs/index.html +1 -1
  160. data/tools/staticdocs/lunr-index-1754357604573.json +1 -0
  161. data/tools/staticdocs/lunr-index.json +1 -1
  162. data/tools/staticdocs/markdown-page.html +1 -1
  163. data/tools/staticdocs/search-doc-1754357604573.json +1 -0
  164. data/tools/staticdocs/search-doc.json +1 -1
  165. data/tools/staticdocs/sitemap.xml +1 -1
  166. metadata +88 -85
  167. data/tools/staticdocs/assets/js/019369f3.52424baa.js +0 -1
  168. data/tools/staticdocs/assets/js/058ffc22.82c2873e.js +0 -1
  169. data/tools/staticdocs/assets/js/0686a885.f620e3dc.js +0 -1
  170. data/tools/staticdocs/assets/js/0f5d161c.e43dd7c9.js +0 -1
  171. data/tools/staticdocs/assets/js/103cc3be.3f08893f.js +0 -1
  172. data/tools/staticdocs/assets/js/13196248.68e92816.js +0 -1
  173. data/tools/staticdocs/assets/js/13c1b4e4.b83f8041.js +0 -1
  174. data/tools/staticdocs/assets/js/1e02e6a3.7cea97a5.js +0 -1
  175. data/tools/staticdocs/assets/js/2047b354.573199a8.js +0 -1
  176. data/tools/staticdocs/assets/js/2124.545702e0.js +0 -1
  177. data/tools/staticdocs/assets/js/22b3ac48.5ab6a17a.js +0 -1
  178. data/tools/staticdocs/assets/js/2368.4443f5c4.js +0 -4
  179. data/tools/staticdocs/assets/js/2bb7bf90.882f03a1.js +0 -1
  180. data/tools/staticdocs/assets/js/2c15ad40.a56e1a40.js +0 -1
  181. data/tools/staticdocs/assets/js/35398c5c.d6cb2a82.js +0 -1
  182. data/tools/staticdocs/assets/js/3dd7ef3b.4782cafe.js +0 -1
  183. data/tools/staticdocs/assets/js/40365d27.4fe19af4.js +0 -1
  184. data/tools/staticdocs/assets/js/411898ad.63be48ce.js +0 -1
  185. data/tools/staticdocs/assets/js/42170351.49ebb70c.js +0 -1
  186. data/tools/staticdocs/assets/js/43652efd.deefbd37.js +0 -1
  187. data/tools/staticdocs/assets/js/54d0d530.97fd90e6.js +0 -1
  188. data/tools/staticdocs/assets/js/59ed27a4.6a4d4905.js +0 -1
  189. data/tools/staticdocs/assets/js/5b233ba7.169a9701.js +0 -1
  190. data/tools/staticdocs/assets/js/5bc719f6.adbdce65.js +0 -1
  191. data/tools/staticdocs/assets/js/5c6ce5ec.1827793d.js +0 -1
  192. data/tools/staticdocs/assets/js/5e3ed378.64ea5a52.js +0 -1
  193. data/tools/staticdocs/assets/js/5fe211ef.866de8e9.js +0 -1
  194. data/tools/staticdocs/assets/js/6831b732.d0e1b5a6.js +0 -1
  195. data/tools/staticdocs/assets/js/696b4199.adf3731a.js +0 -1
  196. data/tools/staticdocs/assets/js/6b210247.bb5dedd5.js +0 -1
  197. data/tools/staticdocs/assets/js/6b65133b.c36fb840.js +0 -1
  198. data/tools/staticdocs/assets/js/6f92e431.13b5aeef.js +0 -1
  199. data/tools/staticdocs/assets/js/72c6d8a8.8f66ae6e.js +0 -1
  200. data/tools/staticdocs/assets/js/75e64983.2bd986ec.js +0 -1
  201. data/tools/staticdocs/assets/js/7719.dfa27269.js +0 -1
  202. data/tools/staticdocs/assets/js/80c97f38.997e4e37.js +0 -1
  203. data/tools/staticdocs/assets/js/867640d5.9dd71bf3.js +0 -1
  204. data/tools/staticdocs/assets/js/89e76475.4d439119.js +0 -1
  205. data/tools/staticdocs/assets/js/8b939c74.5fd8e3e8.js +0 -1
  206. data/tools/staticdocs/assets/js/8f7843ee.b3358f6f.js +0 -1
  207. data/tools/staticdocs/assets/js/9424f0b3.b8d6d2bf.js +0 -1
  208. data/tools/staticdocs/assets/js/964eb012.cb76dd8a.js +0 -1
  209. data/tools/staticdocs/assets/js/97535711.c3a1a5a1.js +0 -1
  210. data/tools/staticdocs/assets/js/99581c43.c9f8e384.js +0 -1
  211. data/tools/staticdocs/assets/js/9d6e81d0.6b6404ff.js +0 -1
  212. data/tools/staticdocs/assets/js/a677c089.d33ab1ca.js +0 -1
  213. data/tools/staticdocs/assets/js/a9987364.530c9592.js +0 -1
  214. data/tools/staticdocs/assets/js/a9b2dc27.50f54e80.js +0 -1
  215. data/tools/staticdocs/assets/js/aa6b6c1b.dc1c4a62.js +0 -1
  216. data/tools/staticdocs/assets/js/b062d239.ff2df9fd.js +0 -1
  217. data/tools/staticdocs/assets/js/b38a6d74.62bc94a3.js +0 -1
  218. data/tools/staticdocs/assets/js/b4596165.7dc1e14d.js +0 -1
  219. data/tools/staticdocs/assets/js/b6d70f94.22ca3e8a.js +0 -1
  220. data/tools/staticdocs/assets/js/b9f60ba6.677e8e46.js +0 -1
  221. data/tools/staticdocs/assets/js/bd0034eb.09d6bbbc.js +0 -1
  222. data/tools/staticdocs/assets/js/c24eae19.3db158fe.js +0 -1
  223. data/tools/staticdocs/assets/js/cb8c3f08.7688d6b1.js +0 -1
  224. data/tools/staticdocs/assets/js/cd879be4.1aff15e7.js +0 -1
  225. data/tools/staticdocs/assets/js/d1b923aa.240ccf18.js +0 -1
  226. data/tools/staticdocs/assets/js/d1bfc316.5c7b9c2f.js +0 -1
  227. data/tools/staticdocs/assets/js/d57a4b5d.82790d9f.js +0 -1
  228. data/tools/staticdocs/assets/js/d5d77c37.51a1f08e.js +0 -1
  229. data/tools/staticdocs/assets/js/d8ca4191.ca5f5dde.js +0 -1
  230. data/tools/staticdocs/assets/js/d9b92eba.41086b81.js +0 -1
  231. data/tools/staticdocs/assets/js/db8fa1d0.5107d903.js +0 -1
  232. data/tools/staticdocs/assets/js/dbe31111.a7be0442.js +0 -1
  233. data/tools/staticdocs/assets/js/dc5f7beb.dfbe012c.js +0 -1
  234. data/tools/staticdocs/assets/js/e501b0d1.512e0a0b.js +0 -1
  235. data/tools/staticdocs/assets/js/f15615f1.d668576a.js +0 -1
  236. data/tools/staticdocs/assets/js/fd886806.656b4fa3.js +0 -1
  237. data/tools/staticdocs/assets/js/main.54699355.js +0 -38
  238. data/tools/staticdocs/assets/js/runtime~main.2a93017a.js +0 -1
  239. data/tools/staticdocs/lunr-index-1751323751078.json +0 -1
  240. data/tools/staticdocs/search-doc-1751323751078.json +0 -1
data/tools/staticdocs/docs/configuration/protocols.html CHANGED
@@ -1,4 +1,4 @@
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-configuration/protocols" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Protocols | 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/configuration/protocols><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="Protocols | OpenC3 Docs"><meta data-rh=true name=description content="Built-in COSMOS protocols including how to create one"><meta data-rh=true property=og:description content="Built-in COSMOS protocols including how to create one"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols 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/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols","name":"Protocols","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.2a93017a.js defer></script><script src=/tools/staticdocs/assets/js/main.54699355.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-configuration/protocols" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Protocols | 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/configuration/protocols><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="Protocols | OpenC3 Docs"><meta data-rh=true name=description content="Built-in COSMOS protocols including how to create one"><meta data-rh=true property=og:description content="Built-in COSMOS protocols including how to create one"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols 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/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols","name":"Protocols","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.3a94737c.css><script src=/tools/staticdocs/assets/js/runtime~main.ff5e0de8.js defer></script><script src=/tools/staticdocs/assets/js/main.8b65f76b.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/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
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"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" 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/configuration/format>File Format</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/configuration/plugins>Plugins</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/configuration/target>Targets</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/configuration/command>Commands</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/configuration/telemetry>Telemetry</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/configuration/interfaces>Interfaces</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/configuration/protocols>Protocols</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/configuration/accessors>Accessors</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/configuration/conversions>Conversions</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/configuration/processors>Processors</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/configuration/limits-response>Limits Response</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/configuration/table>Tables</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/configuration/telemetry-screens>Screens</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/configuration/ssl-tls>SSL-TLS</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/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 menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" 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/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/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Protocols</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>Protocols</h1></header><p>Protocols process data on behalf of an <a href=/tools/staticdocs/docs/configuration/interfaces>Interface</a>. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.</p>
@@ -16,67 +16,79 @@
16
16
  <p>Note the first parameter after the PROTOCOL keyword is how to apply the protocol: READ, WRITE, or READ_WRITE. Read applies the protocol on incoming packets (telemetry) and write on outgoing packets (commands). The next parameter is the protocol filename or class name. All other parameters are protocol specific.</p>
17
17
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cobs-protocol>COBS Protocol<a href=#cobs-protocol class=hash-link aria-label="Direct link to COBS Protocol" title="Direct link to COBS Protocol">​</a></h3>
18
18
  <p>The Consistent Overhead Byte Stuffing (COBS) Protocol is an algorithm for encoding data bytes that results in efficient, reliable, unambiguous packet framing regardless of packet content, thus making it easy for receiving applications to recover from malformed packets. It employs the zero byte value to serve as a packet delimiter (a special value that indicates the boundary between packets). The algorithm replaces each zero data byte with a non-zero value so that no zero data bytes will appear in the packet and thus be misinterpreted as packet boundaries (See <a href=https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing target=_blank rel="noopener noreferrer">https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing</a> for more).</p>
19
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">cobs_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/cobs_protocol.py target=_blank rel="noopener noreferrer">cobs_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> CobsProtocol</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/cobs_protocol.rb target=_blank rel="noopener noreferrer">cobs_protocol.rb</a></div></div></div>
19
20
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=slip-protocol>SLIP Protocol<a href=#slip-protocol class=hash-link aria-label="Direct link to SLIP Protocol" title="Direct link to SLIP Protocol">​</a></h3>
20
21
  <p>The Serial Line IP (SLIP) Protocol defines a sequence of characters that frame IP packets on a serial line. It defines two special characters: END and ESC. END is 0xC0 and ESC is 0xDB. To send a packet, a SLIP host simply starts sending the data in the packet. If a data byte is the same code as END character, a two byte sequence of ESC and 0xDC is sent instead. If a data bytes is the same as an ESC character, an two byte sequence of ESC and 0xDD is sent instead. When the last byte in the packet has been sent, an END character is then transmitted (See <a href=https://datatracker.ietf.org/doc/html/rfc1055 target=_blank rel="noopener noreferrer">https://datatracker.ietf.org/doc/html/rfc1055</a> for more).</p>
21
22
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Start Char<td>Character to place at the start of frames<td>No<td>nil (no character)<tr><td>Read Strip Characters<td>Strip off start_char and end_char from reads<td>No<td>true<tr><td>Read Enable Escaping<td>Whether to enable character escaping on reads<td>No<td>true<tr><td>Write Enable Escaping<td>Whether to enable character escaping on writes<td>No<td>true<tr><td>End Char<td>Character to place at the end of frames<td>No<td>0xC0<tr><td>Esc Char<td>Escape character<td>No<td>0xDB<tr><td>Escape End Char<td>Character to escape End character<td>No<td>0xDC<tr><td>Escape Esc Char<td>Character to escape Esc character<td>No<td>0xDD</table>
23
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><p>Usage in plugin.txt:<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Since we're using the defaults, none of the parameters are actually required</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">slip_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xC0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDC</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDD</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/slip_protocol.py target=_blank rel="noopener noreferrer">slip_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><p>Usage in plugin.txt:<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Since we're using the defaults, none of the parameters are actually required</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> SlipProtocol </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xC0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDC</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDD</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/slip_protocol.rb target=_blank rel="noopener noreferrer">slip_protocol.rb</a></div></div></div>
22
24
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=burst-protocol>Burst Protocol<a href=#burst-protocol class=hash-link aria-label="Direct link to Burst Protocol" title="Direct link to Burst Protocol">​</a></h3>
23
25
  <p>The Burst Protocol simply reads as much data as it can from the interface before returning the data as a COSMOS Packet (It returns a packet for each burst of data read). This Protocol relies on regular bursts of data delimited by time and thus is not very robust. However, it can utilize a sync pattern which does allow it to re-sync if necessary. It can also discard bytes from the incoming data to remove the sync pattern. Finally, it can add sync patterns to data being written out of the Interface.</p>
24
26
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes starting with the sync pattern if the sync pattern is being used.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned<td>No<td>nil (no sync pattern)<tr><td>Fill Fields<td>Whether to fill in the sync pattern on outgoing packets<td>No<td>false</table>
27
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Use a sync pattern but discard it</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">burst_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/burst_protocol.py target=_blank rel="noopener noreferrer">burst_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Use a sync pattern but discard it</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> BurstProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/burst_protocol.rb target=_blank rel="noopener noreferrer">burst_protocol.rb</a></div></div></div>
25
28
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=fixed-protocol>Fixed Protocol<a href=#fixed-protocol class=hash-link aria-label="Direct link to Fixed Protocol" title="Direct link to Fixed Protocol">​</a></h3>
26
29
  <p>The Fixed Protocol reads a preset minimum amount of data which is necessary to properly identify all the defined packets using the interface. It then identifies the packet and proceeds to read as much data from the interface as necessary to create the packet which it then returns. This protocol relies on all the packets on the interface being fixed in length. For example, all the packets using the interface are a fixed size and contain a simple header with a 32-bit sync pattern followed by a 16 bit ID. The Fixed Protocol would elegantly handle this case with a minimum read size of 6 bytes. The Fixed Protocol also supports a sync pattern, discarding leading bytes, and filling the sync pattern similar to the Burst Protocol.</p>
27
30
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Minimum ID Size<td>The minimum number of bytes needed to identify a packet. All the packet definitions must declare their ID_ITEM(s) within this given number of bytes.<td>Yes<td><tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes starting with the sync pattern if the sync pattern is being used.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned.<td>No<td>nil (no sync pattern)<tr><td>Telemetry<td>Whether the data is telemetry<td>No<td>true (false means command)<tr><td>Fill Fields<td>Whether to fill in the sync pattern on outgoing packets<td>No<td>false<tr><td>Unknown Raise<td>Whether to raise an exception for an unknown packet<td>No<td>false</table>
31
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">fixed_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/fixed_protocol.py target=_blank rel="noopener noreferrer">fixed_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> FixedProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/fixed_protocol.rb target=_blank rel="noopener noreferrer">fixed_protocol.rb</a></div></div></div>
28
32
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=length-protocol>Length Protocol<a href=#length-protocol class=hash-link aria-label="Direct link to Length Protocol" title="Direct link to Length Protocol">​</a></h3>
29
33
  <p>The Length Protocol depends on a length field at a fixed location in the defined packets using the interface. It then reads enough data to grab the length field, decodes it, and reads the remaining length of the packet. For example, all the packets using the interface contain a CCSDS header with a length field. The Length Protocol can be set up to handle the length field and even the length offset CCSDS uses. The Length Protocol also supports a sync pattern, discarding leading bytes, and filling the length and sync pattern similar to the Burst Protocol.</p>
30
34
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Length Bit Offset<td>The bit offset from the start of the packet to the length field. Every packet using this interface must have the same structure such that the length field is the same size at the same location. Be sure to account for the length of the Sync Pattern in this value (if present).<td>No<td>0 bits<tr><td>Length Bit Size<td>The size in bits of the length field<td>No<td>16 bits<tr><td>Length Value Offset<td>The offset to apply to the length field value. The actual value of the length field plus this offset should equal the exact number of bytes required to read all data for the packet (including the length field itself, sync pattern, etc). For example, if the length field indicates packet length minus one, this value should be one. Be sure to account for the length of the Sync Pattern in this value (if present).<td>No<td>0<tr><td>Bytes per Count<td>The number of bytes per each length field 'count'. This is used if the units of the length field is something other than bytes, e.g. if the length field count is in words.<td>No<td>1 byte<tr><td>Length Endianness<td>The endianness of the length field. Must be either 'BIG_ENDIAN' or 'LITTLE_ENDIAN'.<td>No<td>'BIG_ENDIAN'<tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used. Discarding is one of the very last steps so any size and offsets above need to account for all the data before discarding.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned.<td>No<td>nil (no sync pattern)<tr><td>Max Length<td>The maximum allowed value in the length field<td>No<td>nil (no maximum length)<tr><td>Fill Length and Sync Pattern<td>Setting this flag to true causes the length field and sync pattern (if present) to be filled automatically on outgoing packets.<td>No<td>false</table>
31
35
  <p>The most confusing aspect of the Length Protocol is calculating the Length Value Offset. This is especially true in the commonly used CCSDS Space Packet Protocol. The best way to illustrate this is with an example. Suppose you have CCSDS Space Packets prepended with a Sync Pattern of 0x1ACFFC1D. This would look like the following:</p>
32
36
  <table><thead><tr><th>Sync (4 bytes)<th>Header (4 bytes)<th>Length (2 bytes)<th>Data (4 bytes)<tbody><tr><td>0x1ACFFC1D<td>0x0001CADB<td>0x0003<td>0xDEADBEEF</table>
33
37
  <p>In this case the total length of the packet is 14 bytes: <strong>4 + 4 + 2 + 4 = 14</strong>. With 4 bytes of data, the length field is 3 because in CCSDS the length field is calculated as (data length - 1). So how would we calculate the Length Value Offset? COSMOS reads all the bytes in the packet (including the Sync Pattern) so the total length is 14 bytes. The length field is 3 so the Length Value Offset (offset to apply to the length field value) should be 11 (<strong>3 + 11 = 14</strong>).</p>
38
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Example length protocol parameters for a CCSDS packet</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">length_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> BIG_ENDIAN </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/length_protocol.py target=_blank rel="noopener noreferrer">length_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Example length protocol parameters for a CCSDS packet</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> LengthProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">64</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/length_protocol.rb target=_blank rel="noopener noreferrer">length_protocol.rb</a></div></div></div>
34
39
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=terminated-protocol>Terminated Protocol<a href=#terminated-protocol class=hash-link aria-label="Direct link to Terminated Protocol" title="Direct link to Terminated Protocol">​</a></h3>
35
40
  <p>The Terminated Protocol delineates packets using termination characters found at the end of every packet. It continuously reads data until the termination characters are found at which point it returns the packet data. For example, all the packets using the interface are followed by 0xABCD. This data can either be a part of each packet that is kept or something which is known only by the Terminated Protocol and simply thrown away.</p>
36
41
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Write Termination Characters<td>The data to write after writing a command packet. Given as a hex string such as 0xABCD.<td>Yes<td><tr><td>Read Termination Characters<td>The characters which delineate the end of a telemetry packet. Given as a hex string such as 0xABCD.<td>Yes<td><tr><td>Strip Read Termination<td>Whether to remove the read termination characters before returning the telemetry packet<td>No<td>true<tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned.<td>No<td>nil (no sync pattern)<tr><td>Fill Fields<td>Whether to fill in the sync pattern on outgoing packets<td>No<td>false</table>
42
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Example newline (0x0A) delimiter and sync pattern of 'DATA' (0x44415441 is ascii for 'DATA')</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">terminated_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">0x0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x44415441</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/terminated_protocol.py target=_blank rel="noopener noreferrer">terminated_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Example newline (0x0A) delimiter and sync pattern of 'DATA' (0x44415441 is ascii for 'DATA')</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> TerminatedProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">0x0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0A</span><span class="token plain"> True </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x44415441</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/terminated_protocol.rb target=_blank rel="noopener noreferrer">terminated_protocol.rb</a></div></div></div>
37
43
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=gems-protocol-enterprise>GEMS Protocol (Enterprise)<a href=#gems-protocol-enterprise class=hash-link aria-label="Direct link to GEMS Protocol (Enterprise)" title="Direct link to GEMS Protocol (Enterprise)">​</a></h3>
38
- <p>The GEMS Protocol implements the Ground Equipment Monitoring Service protocol. It is added along with the TerminatedProtocol which delineates packets using '|END'. The GEMS Interface is currently only implemented in Ruby.</p>
39
- <p>The GEMS protocol doesn't take any parameters but should be added to an interface after the TerminatedProtocol and CmdResponseProtocol.</p>
40
- <p>plugin.txt Ruby Example:</p>
41
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GEMS_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">operator </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># TerminatedProtocol 0x7C454E44 0x7C454E44 false 0 0x7C47454D53 false ... means:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># wtc rtc strip discard sync fill</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># where wtc = write termination characters, end of the gems protocol: 0x7C454E44 == '|END'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># rtc = read termination characters, end of the gems protocol: 0x7C454E44 == '|END'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># strip = strip read termination (false)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># discard = 0 bytes</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># sync pattern = beginning of the GEMS protocol: 0x7C47454D53 == '|GEMS'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># fill = whether to fill in the sync pattern (false as we specify fill in our cmd/tlm definitions)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> TerminatedProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C454E44</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C454E44</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C47454D53</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># CmdResponseProtocol 5.0 0.2 true means:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># 5 sec response timeout, 0.2 sec response polling,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># and true to raise exceptions when protocol errors occur</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ_WRITE</span><span class="token plain"> CmdResponseProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">5.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.2</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ_WRITE</span><span class="token plain"> GemsProtocol</span><br></span></code></pre></div></div>
44
+ <p>The GEMS Protocol implements the Ground Equipment Monitoring Service protocol. It is added along with the Terminated Protocol which delineates packets using '|END'. The GEMS Interface is currently only implemented in Ruby.</p>
45
+ <p>The GEMS protocol doesn't take any parameters but should be added to an interface after the Terminated Protocol and Command Response Protocol.</p>
46
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GEMS_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">operator </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># TerminatedProtocol 0x7C454E44 0x7C454E44 false 0 0x7C47454D53 false ... means:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># wtc rtc strip discard sync fill</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># where wtc = write termination characters, end of the gems protocol: 0x7C454E44 == '|END'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># rtc = read termination characters, end of the gems protocol: 0x7C454E44 == '|END'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># strip = strip read termination (false)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># discard = 0 bytes</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># sync pattern = beginning of the GEMS protocol: 0x7C47454D53 == '|GEMS'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># fill = whether to fill in the sync pattern (false as we specify fill in our cmd/tlm definitions)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> TerminatedProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C454E44</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C454E44</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x7C47454D53</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># CmdResponseProtocol 5.0 0.2 true means:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># 5 sec response timeout, 0.2 sec response polling,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># and true to raise exceptions when protocol errors occur</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ_WRITE</span><span class="token plain"> CmdResponseProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">5.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.2</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ_WRITE</span><span class="token plain"> GemsProtocol</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/blob/main/openc3-cosmos-gems-interface/lib/gems_protocol.rb target=_blank rel="noopener noreferrer">gems_protocol.rb</a></div></div></div>
42
47
  <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-gems-interface target=_blank rel="noopener noreferrer">openc3-cosmos-gems-interface</a> in the COSMOS Enterprise Plugins.</p>
43
48
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ccsds-cltu-protocol-enterprise>CCSDS CLTU Protocol (Enterprise)<a href=#ccsds-cltu-protocol-enterprise class=hash-link aria-label="Direct link to CCSDS CLTU Protocol (Enterprise)" title="Direct link to CCSDS CLTU Protocol (Enterprise)">​</a></h3>
44
49
  <p>The CCSDS CLTU Protocol handles the CLTU (Communicates Link Transfer Unit) for Command Streams. It encodes outgoing messages with a BCH encoding and then applies a header and footer to the data.</p>
45
50
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Header<td>Header before BCH encoded data<td>No<td>0xEB90<tr><td>Footer<td>Footer after BCH encoded data<td>No<td>0xC5C5C5C5C5C5C579<tr><td>Fill Byte<td>BCH encoding fill byte<td>No<td>0x55</table>
51
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">params</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WRITE</span><span class="token plain"> CcsdsCltuProtocol</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/blob/main/openc3-cosmos-ccsds-protocols/lib/ccsds_cltu_protocol.rb target=_blank rel="noopener noreferrer">cltu_protocol.rb</a></div></div></div>
46
52
  <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-ccsds-protocols target=_blank rel="noopener noreferrer">openc3-cosmos-ccsds-protocols</a> in the COSMOS Enterprise Plugins.</p>
47
53
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ccsds-tctf-protocol-enterprise>CCSDS TCTF Protocol (Enterprise)<a href=#ccsds-tctf-protocol-enterprise class=hash-link aria-label="Direct link to CCSDS TCTF Protocol (Enterprise)" title="Direct link to CCSDS TCTF Protocol (Enterprise)">​</a></h3>
48
54
  <p>The CCSDS TCTF Protocol handles the Telecommand Transfer Frame for Command Streams.</p>
49
55
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Randomization<td>Whether to encode and randomize the transfer frame<td>No<td>true<tr><td>Error Control<td>Whether to use the Frame Error Control Field and apply a 16 bit CRC<td>No<td>false<tr><td>Bypass<td>Bypass bit where 0 is Type-A and 1 is Type-B (bypass frame acceptance checks)<td>No<td>1<tr><td>SCID<td>Spacecraft Identifier (10 bits)<td>No<td>0<tr><td>VCID<td>Virtual Channel Identifier (6 bits)<td>No<td>0</table>
56
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">params</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WRITE</span><span class="token plain"> CcsdsTctfProtocol </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/blob/main/openc3-cosmos-ccsds-protocols/lib/ccsds_tctf_protocol.rb target=_blank rel="noopener noreferrer">ccsds_tctf_protocol.rb</a></div></div></div>
50
57
  <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-ccsds-protocols target=_blank rel="noopener noreferrer">openc3-cosmos-ccsds-protocols</a> in the COSMOS Enterprise Plugins.</p>
51
58
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ccsds-tmtf-protocol-enterprise>CCSDS TMTF Protocol (Enterprise)<a href=#ccsds-tmtf-protocol-enterprise class=hash-link aria-label="Direct link to CCSDS TMTF Protocol (Enterprise)" title="Direct link to CCSDS TMTF Protocol (Enterprise)">​</a></h3>
52
59
  <p>The CCSDS TMTF Protocol handles the Telemetry Transfer Frame for Telemetry Streams. It adds VCID, MC_FRM_CNT, VC_FRM_CNT to extra which will be included in the Decom data.</p>
53
60
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>SCID<td>Spacecraft Identifier (10 bits)<td>Yes<td><tr><td>Frame Length<td><td>No<td>2048<tr><td>Randomization<td>Whether the transfer frame was encoded and randomized<td>No<td>true<tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned.<td>No<td>0x1ACFFC1D<tr><td>Fill Fields<td>Whether to fill in the sync pattern on outgoing packets<td>No<td>true</table>
61
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">params</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> CcsdsTmtfProtocol </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x1ACFFC1D</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/blob/main/openc3-cosmos-ccsds-protocols/lib/ccsds_tmtf_protocol.rb target=_blank rel="noopener noreferrer">ccsds_tmtf_protocol.rb</a></div></div></div>
54
62
  <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-ccsds-protocols target=_blank rel="noopener noreferrer">openc3-cosmos-ccsds-protocols</a> in the COSMOS Enterprise Plugins.</p>
55
63
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=template-protocol-deprecated>Template Protocol (Deprecated)<a href=#template-protocol-deprecated class=hash-link aria-label="Direct link to Template Protocol (Deprecated)" title="Direct link to Template Protocol (Deprecated)">​</a></h3>
56
- <p>This protocol is now deprecated because it is not able to capture the original SCPI messages in COSMOS raw logging. Please use the TemplateAccessor with the CmdResponseProtocol instead.</p>
64
+ <p>This protocol is now deprecated because it is not able to capture the original SCPI messages in COSMOS raw logging. Please use the TemplateAccessor with the Command Response Protocol instead.</p>
57
65
  <p>The Template Protocol works much like the Terminated Protocol except it is designed for text-based command and response type interfaces such as SCPI (Standard Commands for Programmable Instruments). It delineates packets in the same way as the Terminated Protocol except each packet is referred to as a line (because each usually contains a line of text). For outgoing packets, a CMD_TEMPLATE field is expected to exist in the packet. This field contains a template string with items to be filled in delineated within HTML tag style brackets <code>"&lt;EXAMPLE>"</code>. The Template Protocol will read the named items from within the packet and fill in the CMD_TEMPLATE. This filled in string is then sent out rather than the originally passed in packet. Correspondingly, if a response is expected the outgoing packet should include a RSP_TEMPLATE and RSP_PACKET field. The RSP_TEMPLATE is used to extract data from the response string and build a corresponding RSP_PACKET. See the TEMPLATE target within the COSMOS Demo configuration for an example of usage.</p>
58
66
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Write Termination Characters<td>The data to write after writing a command packet. Given as a hex string such as 0xABCD.<td>Yes<td><tr><td>Read Termination Characters<td>The characters which delineate the end of a telemetry packet. Given as a hex string such as 0xABCD.<td>Yes<td><tr><td>Ignore Lines<td>Number of response lines to ignore (completely drop)<td>No<td>0 lines<tr><td>Initial Read Delay<td>An initial delay after connecting after which the interface will be read till empty and data dropped. Useful for discarding connect headers and initial prompts.<td>No<td>nil (no initial read)<tr><td>Response Lines<td>The number of lines that make up expected responses<td>No<td>1 line<tr><td>Strip Read Termination<td>Whether to remove the read termination characters before returning the telemetry packet<td>No<td>true<tr><td>Discard Leading Bytes<td>The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used.<td>No<td>0 (do not discard bytes)<tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned.<td>No<td>nil (no sync pattern)<tr><td>Fill Fields<td>Whether to fill in the sync pattern on outgoing packets<td>No<td>false<tr><td>Response Timeout<td>Number of seconds to wait for a response before timing out<td>No<td>5.0<tr><td>Response Polling Period<td>Number of seconds to wait between polling for a response<td>No<td>0.02<tr><td>Raise Exceptions<td>Whether to raise exceptions when errors occur like timeouts or unexpected responses<td>No<td>false</table>
59
67
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=preidentified-protocol>Preidentified Protocol<a href=#preidentified-protocol class=hash-link aria-label="Direct link to Preidentified Protocol" title="Direct link to Preidentified Protocol">​</a></h3>
60
68
  <p>The Preidentified Protocol delineates packets using the COSMOS header. This Protocol was created to allow tools to connect and receive the entire packet stream. It can be used with the <a href=/tools/staticdocs/docs/configuration/interfaces#file-interface>FileInterface</a> to process COSMOS 4 log files. It can also be used to chain COSMOS instances together although that should rarely be needed with the new web native implementation.</p>
61
69
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Sync Pattern<td>Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found AFTER the sync pattern will be returned. The sync pattern itself is discarded.<td>No<td>nil (no sync pattern)<tr><td>Max Length<td>The maximum allowed value in the length field<td>No<td>nil (no maximum length)</table>
70
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">preidentified_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/preidentified_protocol.py target=_blank rel="noopener noreferrer">preidentified_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> PreidentifiedProtocol</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/preidentified_protocol.rb target=_blank rel="noopener noreferrer">preidentified_protocol.rb</a></div></div></div>
62
71
  <p>For an example of using Preidentified Protocol see <a href=/tools/staticdocs/docs/configuration/interfaces#file-interface>FileInterface</a>.</p>
63
72
  <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=helper-protocols>Helper Protocols<a href=#helper-protocols class=hash-link aria-label="Direct link to Helper Protocols" title="Direct link to Helper Protocols">​</a></h2>
64
- <p>COSMOS provides the following helper protocols: CmdResponse, Crc and Ignore. These protocols provide helper functionality to Interfaces.</p>
65
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmdresponse-protocol>CmdResponse Protocol<a href=#cmdresponse-protocol class=hash-link aria-label="Direct link to CmdResponse Protocol" title="Direct link to CmdResponse Protocol">​</a></h3>
66
- <p>The CmdResponse Protocol waits for a response for any commands with a defined response packet.</p>
73
+ <p>COSMOS provides the following helper protocols: Command Response, Crc and Ignore. These protocols provide helper functionality to Interfaces.</p>
74
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=command-response-protocol>Command Response Protocol<a href=#command-response-protocol class=hash-link aria-label="Direct link to Command Response Protocol" title="Direct link to Command Response Protocol">​</a></h3>
75
+ <p>The Command Response Protocol waits for a response for any commands with a defined response packet.</p>
67
76
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Response Timeout<td>Number of seconds to wait before timing out when waiting for a response<td>No<td>5<tr><td>Response Polling Period<td>Number of seconds to wait between polling for a response<td>No<td>0.02<tr><td>Raise Exceptions<td>Whether to raise exceptions when errors occur in the protocol like unexpected responses or response timeouts<td>No<td>false</table>
77
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">cmd_response_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">5.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.1</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/cmd_response_protocol.py target=_blank rel="noopener noreferrer">cmd_response_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> CmdResponseProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">5.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.1</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/cmd_response_protocol.rb target=_blank rel="noopener noreferrer">cmd_response_protocol.rb</a></div></div></div>
68
78
  <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=packet-definitions>Packet Definitions<a href=#packet-definitions class=hash-link aria-label="Direct link to Packet Definitions" title="Direct link to Packet Definitions">​</a></h4>
69
- <p>The CmdResponseProtocol utilizes the <a href=/tools/staticdocs/docs/configuration/command#response>RESPONSE</a> keyword in the command definition to determine which telemetry packet should be expected when the given command is sent.</p>
70
- <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">COMMAND SCPI_PS GET_STATUS BIG_ENDIAN "Gets status"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> ACCESSOR TemplateAccessor</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> TEMPLATE ":MEAS:VOLT? (@1:2)"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> RESPONSE SCPI_PS STATUS</span><br></span></code></pre></div></div>
79
+ <p>The Command Response Protocol utilizes the <a href=/tools/staticdocs/docs/configuration/command#response>RESPONSE</a> keyword in the command definition to determine which telemetry packet should be expected when the given command is sent. This will block the command until the response is received.</p>
80
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SCPI_PS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GET_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Gets status"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ACCESSOR</span><span class="token plain"> TemplateAccessor</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">":MEAS:VOLT? (@1:2)"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RESPONSE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SCPI_PS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATUS</span><br></span></code></pre></div></div>
71
81
  <p>The Response packet (STATUS) should be defined to contain the response data.</p>
72
- <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">TELEMETRY SCPI_PS STATUS BIG_ENDIAN "Status"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> ACCESSOR TemplateAccessor</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> TEMPLATE "&lt;MEAS_VOLTAGE_1>,&lt;MEAS_VOLTAGE_2>"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> APPEND_ITEM MEAS_VOLTAGE_1 32 FLOAT "Voltage Reading for Channel 1"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> UNITS VOLTS V</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> FORMAT_STRING %0.3f</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> APPEND_ITEM MEAS_VOLTAGE_2 32 FLOAT "Voltage Reading for Channel 2"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> UNITS VOLTS V</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> FORMAT_STRING %0.3f</span><br></span></code></pre></div></div>
82
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SCPI_PS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Status"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ACCESSOR</span><span class="token plain"> TemplateAccessor</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"&lt;MEAS_VOLTAGE_1>,&lt;MEAS_VOLTAGE_2>"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MEAS_VOLTAGE_1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Voltage Reading for Channel 1"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VOLTS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">V</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token number" style="color:rgb(247, 140, 108)">0.3</span><span class="token plain">f</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MEAS_VOLTAGE_2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Voltage Reading for Channel 2"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VOLTS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">V</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">%</span><span class="token number" style="color:rgb(247, 140, 108)">0.3</span><span class="token plain">f</span><br></span></code></pre></div></div>
73
83
  <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-scpi-power-supply target=_blank rel="noopener noreferrer">openc3-cosmos-scpi-power-supply</a> in the COSMOS Enterprise Plugins.</p>
74
84
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=crc-protocol>CRC Protocol<a href=#crc-protocol class=hash-link aria-label="Direct link to CRC Protocol" title="Direct link to CRC Protocol">​</a></h3>
75
85
  <p>The CRC protocol can add CRCs to outgoing commands and verify CRCs on incoming telemetry packets.</p>
76
86
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Write Item Name<td>Item to fill with calculated CRC value for outgoing packets (nil = don't fill)<td>No<td>nil<tr><td>Strip CRC<td>Whether to remove the CRC from incoming packets<td>No<td>false<tr><td>Bad Strategy<td>How to handle CRC errors on incoming packets. ERROR = Just log the error, DISCONNECT = Disconnect interface<td>No<td>"ERROR"<tr><td>Bit Offset<td>Bit offset of the CRC in the data. Can be negative to indicate distance from end of packet<td>No<td>-32<tr><td>Bit Size<td>Bit size of the CRC - Must be 16, 32, or 64<td>No<td>32<tr><td>Endianness<td>Endianness of the CRC (BIG_ENDIAN/LITTLE_ENDIAN)<td>No<td>"BIG_ENDIAN"<tr><td>Poly<td>Polynomial to use when calculating the CRC expressed as an integer<td>No<td>nil (use default polynomial - 16-bit=0x1021, 32-bit=0x04C11DB7, 64-bit=0x42F0E1EBA9EA3693)<tr><td>Seed<td>Seed value to start the calculation<td>No<td>nil (use default seed - 16-bit=0xFFFF, 32-bit=0xFFFFFFFF, 64-bit=0xFFFFFFFFFFFFFFFF)<tr><td>Xor<td>Whether to XOR the CRC result with 0xFFFF<td>No<td>nil (use default value - 16-bit=false, 32-bit=true, 64-bit=true)<tr><td>Reflect<td>Whether to bit reverse each byte of data before calculating the CRC<td>No<td>nil (use default value - 16-bit=false, 32-bit=true, 64-bit=true)</table>
87
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Handle a trailing 32 bit CRC on telemetry by stripping it off</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">crc_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">True</span><span class="token plain"> ERROR </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> BIG_ENDIAN </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/crc_protocol.py target=_blank rel="noopener noreferrer">crc_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Handle a trailing 32 bit CRC on telemetry by stripping it off</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> CrcProtocol </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ERROR</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/crc_protocol.rb target=_blank rel="noopener noreferrer">crc_protocol.rb</a></div></div></div>
77
88
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ignore-packet-protocol>Ignore Packet Protocol<a href=#ignore-packet-protocol class=hash-link aria-label="Direct link to Ignore Packet Protocol" title="Direct link to Ignore Packet Protocol">​</a></h3>
78
89
  <p>The Ignore Packet protocol drops specified command packets sent by COSMOS or drops incoming telemetry packets.</p>
79
90
  <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Target Name<td>Target name of the packet to ignore<td>Yes<td>nil<tr><td>Packet Name<td>Packet name of the packet to ignore<td>Yes<td>nil</table>
91
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE INTERFACE_NAME </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Ignore the INST MECH packet</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interfaces</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">protocols</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ignore_packet_protocol</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py INST MECH</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/ignore_packet_protocol.py target=_blank rel="noopener noreferrer">ignore_packet_protocol.py</a></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;</span><span class="token plain">parameters</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Ignore the INST MECH packet</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> IgnorePacketProtocol </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MECH</span><br></span></code></pre></div></div><p>Source code for <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/ignore_packet_protocol.rb target=_blank rel="noopener noreferrer">ignore_packet_protocol.rb</a></div></div></div>
80
92
  <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=custom-protocols>Custom Protocols<a href=#custom-protocols class=hash-link aria-label="Direct link to Custom Protocols" title="Direct link to Custom Protocols">​</a></h2>
81
93
  <p>Creating a custom protocol is easy and should be the default solution for customizing COSMOS Interfaces (rather than creating a new Interface class). However, creating custom Interfaces is still useful for defaulting parameters to values that always are fixed for your target and for including the necessary Protocols. The COSMOS Interfaces take a lot of parameters that can be confusing to your end users. Thus you may want to create a custom Interface just to hard coded these values and cut the available parameters down to something like the hostname and port to connect to.</p>
82
94
  <p>All custom Protocols should derive from the Protocol class <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/protocol.rb target=_blank rel="noopener noreferrer">openc3/interfaces/protocols/protocol.rb</a> (Ruby) and <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols/protocol.py target=_blank rel="noopener noreferrer">openc3/interfaces/protocols/protocol.py</a> (Python). This class defines the 9 methods that are relevant to writing your own protocol. The base class implementation for each method is included below as well as a discussion as to how the methods should be overridden and used in your own Protocols.</p>
@@ -89,77 +101,57 @@
89
101
  <p>On <em>every</em> call to read, an empty string "" is first passed down to each of the read Protocol's <code>read_data()</code> method <em>before</em> new raw data is attempted to be read using the Interface's <code>read_interface()</code> method. This is a signal to Protocols that have cached up more than one packet worth of data to output those cached packets before any new data is read from the Interface. Typically no data will be cached up and one of the Protocols <code>read_data()</code> methods will return STOP in response to the empty string, indicating that more data is required to generate a packet. Each Protocol's <code>read_data()</code> method can return one of three things: data that will be passed down to any additional Protocols or turned into a Packet, STOP which means more data is required from the Interface for the Protocol to continue, or DISCONNECT which means that something has happened that requires disconnecting the Interface (and by default trying to reconnect). Each Protocol's <code>read_data()</code> method is passed the data that will eventually be turned into a packet and returns a possibly modified set of data. If the data passes through all Protocol's <code>read_data()</code> methods it is then converted into a COSMOS packet using the Interface's convert_data_to_packet() method. This packet is then run in a similar fashion through each Read Protocol's read_packet() method. This method has essentially the same return possibilities: a Packet (instead of data as in <code>read_data()</code>), STOP, or DISCONNECT. If the Packet makes it through all read_packet() methods then the Interface packet read counter is incremented and the Packet is returned to the Interface.</p>
90
102
  <p><img decoding=async loading=lazy alt="Interface Write Logic" src=/tools/staticdocs/assets/images/interface_write_logic-3360afe1b4af20b10dafba848a21e09baccaacc06e2ec8b6c132ac7a3c99e994.png width=931 height=944 class=img__Ss2></p>
91
103
  <p>The Interface write() method works very similarly to read. (It should be mentioned that by default write protocols run in the reverse order of read protocols. This makes sense because when reading you're typically stripping layers of data and when writing you're typically adding on layers in reverse order.)</p>
92
- <p>First, the packet write counter is incremented. Then each write Protocol is given a chance to modify the packet by its write_packet() method being called. This method can either return a potentially modified packet, STOP, or DISCONNECT. If a write Protocol returns STOP no data will be written out the Interface and it is assumed that more packets are necessary before a final packet can be output. DISCONNECT will disconnect the Interface. If the packet makes it through all the write Protocol's write_packet() methods, then it is converted to binary data using the Interface's convert_packet_to_data() method. Next the write_data() method is called for each write Protocol giving it a chance to modify the lower level data. The same return options are available except a Ruby string of data is returned instead of a COSMOS packet. If the data makes it through all write_data() methods, then it is written out on the Interface using the write_interface() method. Afterwards, each Protocol's post_write_interface() method is called with both the final modified Packet, and the actual data written out to the Interface. This method allows follow-up such as waiting for a response after writing out a message.</p>
104
+ <p>First, the packet write counter is incremented. Then each write Protocol is given a chance to modify the packet by its write_packet() method being called. This method can either return a potentially modified packet, STOP, or DISCONNECT. If a write Protocol returns STOP no data will be written out the Interface and it is assumed that more packets are necessary before a final packet can be output. DISCONNECT will disconnect the Interface. If the packet makes it through all the write Protocol's write_packet() methods, then it is converted to binary data using the Interface's convert_packet_to_data() method. Next the write_data() method is called for each write Protocol giving it a chance to modify the lower level data. The same return options are available except a Ruby string or Python bytes object is returned instead of a COSMOS packet. If the data makes it through all write_data() methods, then it is written out on the Interface using the write_interface() method. Afterwards, each Protocol's post_write_interface() method is called with both the final modified Packet, and the actual data written out to the Interface. This method allows follow-up such as waiting for a response after writing out a message.</p>
93
105
  <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=method-discussions>Method discussions<a href=#method-discussions class=hash-link aria-label="Direct link to Method discussions" title="Direct link to Method discussions">​</a></h2>
94
106
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=initialize-or-init>initialize or <strong>init</strong><a href=#initialize-or-init class=hash-link aria-label="Direct link to initialize-or-init" title="Direct link to initialize-or-init">​</a></h3>
95
107
  <p>This is the constructor for your custom Protocol. It should always call super(allow_empty_data) to initialize the base Protocol class.</p>
96
- <p>Base class Ruby implementation:</p>
97
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># @param allow_empty_data [true/false] Whether STOP should be returned on empty data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">initialize</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</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 variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> ConfigParser</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">handle_true_false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data</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"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
98
- <p>Base class Python implementation:</p>
99
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">__init__</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> allow_empty_data</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> ConfigParser</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">handle_true_false_none</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
108
+ <p>Base class implementation:</p>
109
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">__init__</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> allow_empty_data</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> ConfigParser</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">handle_true_false_none</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># @param allow_empty_data [true/false] Whether STOP should be returned on empty data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">initialize</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</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 variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> ConfigParser</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">handle_true_false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">allow_empty_data</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"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
100
110
  <p>As you can see, every Protocol maintains state on at least two items. The interface variable holds the Interface class instance that the protocol is associated with. This is sometimes necessary to introspect details that only the Interface knows. allow_empty_data is a flag used by the <code>read_data(data)</code> method that is discussed later in this document.</p>
101
111
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reset>reset<a href=#reset class=hash-link aria-label="Direct link to reset" title="Direct link to reset">​</a></h3>
102
112
  <p>The reset method is used to reset internal protocol state when the Interface is connected and/or disconnected. This method should be used for common resetting logic. Connect and Disconnect specific logic are handled in the next two methods.</p>
103
- <p>Base class Ruby implementation:</p>
104
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
105
- <p>Base class Python implementation:</p>
106
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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 keyword" style="color:rgb(127, 219, 202)">pass</span><br></span></code></pre></div></div>
113
+ <p>Base class implementation:</p>
114
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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 keyword" style="color:rgb(127, 219, 202)">pass</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
107
115
  <p>As you can see, the base class reset implementation doesn't do anything.</p>
108
116
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=connect_reset>connect_reset<a href=#connect_reset class=hash-link aria-label="Direct link to connect_reset" title="Direct link to connect_reset">​</a></h3>
109
117
  <p>The connect_reset method is used to reset internal Protocol state each time the Interface is connected.</p>
110
- <p>Base class Ruby implementation:</p>
111
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">connect_reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
112
- <p>Base class Python implementation:</p>
113
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">connect_reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
118
+ <p>Base class implementation:</p>
119
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">connect_reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">connect_reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
114
120
  <p>The base class connect_reset implementation just calls the reset method to ensure common reset logic is run.</p>
115
121
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disconnect_reset>disconnect_reset<a href=#disconnect_reset class=hash-link aria-label="Direct link to disconnect_reset" title="Direct link to disconnect_reset">​</a></h3>
116
122
  <p>The disconnect_reset method is used to reset internal Protocol state each time the Interface is disconnected.</p>
117
- <p>Base class Ruby implementation:</p>
118
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">disconnect_reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
119
- <p>Base class Python implementation:</p>
120
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">disconnect_reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
123
+ <p>Base class implementation:</p>
124
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">disconnect_reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</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"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">reset</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">disconnect_reset</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> reset</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 keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
121
125
  <p>The base class disconnect_reset implementation just calls the reset method to ensure common reset logic is run.</p>
122
126
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=read_data>read_data<a href=#read_data class=hash-link aria-label="Direct link to read_data" title="Direct link to read_data">​</a></h3>
123
127
  <p>The read_data method is used to analyze and potentially modify any raw data read by an Interface. It takes one parameter as the current state of the data to be analyzed. It can return either a string of data, STOP, or DISCONNECT. If it returns a string, then it believes that data may be ready to be a full packet, and is ready for processing by any following Protocols. If STOP is returned then the Protocol believes it needs more data to complete a full packet. If DISCONNECT is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected).</p>
124
- <p>Base class Ruby implementation:</p>
125
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">read_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">length </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;=</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token operator" style="color:rgb(127, 219, 202)">?</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">and</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read_protocols</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">self</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Last read interface in chain with auto @allow_empty_data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token symbol">:STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">elsif</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">!</span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Don't @allow_empty_data means STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token symbol">:STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
126
- <p>Base class Python implementation:</p>
127
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">read_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">len</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;=</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data </span><span class="token keyword" style="color:rgb(127, 219, 202)">is</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface </span><span class="token keyword" style="color:rgb(127, 219, 202)">and</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read_protocols</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> self</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Last read interface in chain with auto self.allow_empty_data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</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)">"STOP"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</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 keyword" style="color:rgb(127, 219, 202)">elif</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Don't self.allow_empty_data means STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</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)">"STOP"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
128
+ <p>Base class implementation:</p>
129
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">read_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">len</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;=</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data </span><span class="token keyword" style="color:rgb(127, 219, 202)">is</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface </span><span class="token keyword" style="color:rgb(127, 219, 202)">and</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read_protocols</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> self</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Last read interface in chain with auto self.allow_empty_data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</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)">"STOP"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</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 keyword" style="color:rgb(127, 219, 202)">elif</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">allow_empty_data</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Don't self.allow_empty_data means STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</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)">"STOP"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">read_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">length </span><span class="token operator" style="color:rgb(127, 219, 202)">&lt;=</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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 keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token operator" style="color:rgb(127, 219, 202)">?</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">if</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">and</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read_protocols</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">self</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Last read interface in chain with auto @allow_empty_data</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token symbol">:STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">elsif</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">!</span><span class="token variable" style="color:rgb(214, 222, 235)">@allow_empty_data</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Don't @allow_empty_data means STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token symbol">:STOP</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
128
130
  <p>The base class implementation does nothing except return the data it was given. The only exception to this is when handling an empty string. If the allow_empty_data flag is false / False or if it is nil / None and the Protocol is the last in the chain, then the base implementation will return STOP to indicate that it is time to call the Interface <code>read_interface()</code> method to get more data. Blank strings are used to signal Protocols that they have an opportunity to return a cached packet.</p>
129
131
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=read_packet>read_packet<a href=#read_packet class=hash-link aria-label="Direct link to read_packet" title="Direct link to read_packet">​</a></h3>
130
132
  <p>The read_packet method is used to analyze and potentially modify a COSMOS packet before it is returned by the Interface. It takes one parameter as the current state of the packet to be analyzed. It can return either a COSMOS packet, STOP, or DISCONNECT. If it returns a COSMOS packet, then it believes that the packet is valid, should be returned, and is ready for processing by any following Protocols. If STOP is returned then the Protocol believes the packet should be silently dropped. If DISCONNECT is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected). This method is where a Protocol would set the stored flag on a packet if it determines that the packet is stored telemetry instead of real-time telemetry.</p>
131
- <p>Base class Ruby implementation:</p>
132
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">read_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
133
- <p>Base class Python implementation:</p>
134
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">read_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span></code></pre></div></div>
133
+ <p>Base class implementation:</p>
134
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">read_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">read_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
135
135
  <p>The base class always just returns the packet given.</p>
136
136
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=write_packet>write_packet<a href=#write_packet class=hash-link aria-label="Direct link to write_packet" title="Direct link to write_packet">​</a></h3>
137
137
  <p>The write_packet method is used to analyze and potentially modify a COSMOS packet before it is output by the Interface. It takes one parameter as the current state of the packet to be analyzed. It can return either a COSMOS packet, STOP, or DISCONNECT. If it returns a COSMOS packet, then it believes that the packet is valid, should be written out the Interface, and is ready for processing by any following Protocols. If STOP is returned then the Protocol believes the packet should be silently dropped. If DISCONNECT is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected).</p>
138
- <p>Base class Ruby implementation:</p>
139
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">write_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
140
- <p>Base class Python implementation:</p>
141
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">write_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span></code></pre></div></div>
138
+ <p>Base class implementation:</p>
139
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">write_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">write_packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
142
140
  <p>The base class always just returns the packet given.</p>
143
141
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=write_data>write_data<a href=#write_data class=hash-link aria-label="Direct link to write_data" title="Direct link to write_data">​</a></h3>
144
142
  <p>The write_data method is used to analyze and potentially modify data before it is written out by the Interface. It takes one parameter as the current state of the data to be analyzed and sent. It can return either a string of data, STOP, or DISCONNECT. If it returns a string of data, then it believes that the data is valid, should be written out the Interface, and is ready for processing by any following Protocols. If STOP is returned then the Protocol believes the data should be silently dropped. If DISCONNECT is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected).</p>
145
- <p>Base class Ruby implementation:</p>
146
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">write_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
147
- <p>Base class Python implementation:</p>
148
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">write_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
143
+ <p>Base class implementation:</p>
144
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">write_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">write_data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">data</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
149
145
  <p>The base class always just returns the data given.</p>
150
146
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=post_write_interface>post_write_interface<a href=#post_write_interface class=hash-link aria-label="Direct link to post_write_interface" title="Direct link to post_write_interface">​</a></h3>
151
147
  <p>The post_write_interface method is called after data has been written out the Interface. The typical use of this method is to provide a hook to implement command/response type interfaces where a response is always immediately expected in response to a command. It takes two parameters, the packet after all modifications by <code>write_packet()</code> and the data that was actually written out the Interface. It can return either the same pair of packet/data, STOP, or DISCONNECT. If it returns a packet/data pair then they are passed on to any other Protocols. If STOP is returned then the Interface write() call completes and no further Protocols <code>post_write_interface()</code> methods are called. If DISCONNECT is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected). Note that only the first parameter "packet", is checked to be STOP, or DISCONNECT on the return.</p>
152
- <p>Base class Ruby implementation:</p>
153
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">post_write_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
154
- <p>Base class Python implementation:</p>
155
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">post_write_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div>
148
+ <p>Base class implementation:</p>
149
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">post_write_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> extra</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">post_write_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</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 keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> data</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
156
150
  <p>The base class always just returns the packet/data given.</p>
157
151
  <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=protocol_cmd>protocol_cmd<a href=#protocol_cmd class=hash-link aria-label="Direct link to protocol_cmd" title="Direct link to protocol_cmd">​</a></h3>
158
152
  <p>The protocol_cmd method is used to send commands to the protocol itself. This is useful to change protocol behavior during runtime. See <a href=/tools/staticdocs/docs/guides/scripting-api#interface_protocol_cmd>interface_protocol_cmd</a> for more information.</p>
159
- <p>Base class Ruby implementation:</p>
160
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">protocol_cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">cmd_name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain">cmd_args</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Default do nothing - Implemented by subclasses</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div>
161
- <p>Base class Python implementation:</p>
162
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">protocol_cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> cmd_name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain">cmd_args</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Default do nothing - Implemented by subclasses</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">False</span><br></span></code></pre></div></div>
153
+ <p>Base class implementation:</p>
154
+ <div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">protocol_cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> cmd_name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain">cmd_args</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Default do nothing - Implemented by subclasses</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">False</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">protocol_cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">cmd_name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain">cmd_args</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Default do nothing - Implemented by subclasses</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre></div></div></div></div></div>
163
155
  <p>The base class does nothing as this is special functionality implemented by subclasses.</p>
164
156
  <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=examples>Examples<a href=#examples class=hash-link aria-label="Direct link to Examples" title="Direct link to Examples">​</a></h2>
165
- <p>Please see the linked <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols target=_blank rel="noopener noreferrer">Ruby Protocol</a> and <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols target=_blank rel="noopener noreferrer">Python Protocol</a> code for examples of the above methods in action.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/protocols.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/configuration/interfaces><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Interfaces</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/accessors><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Accessors</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-delineation-protocols class="table-of-contents__link toc-highlight">Packet Delineation Protocols</a><ul><li><a href=#cobs-protocol class="table-of-contents__link toc-highlight">COBS Protocol</a><li><a href=#slip-protocol class="table-of-contents__link toc-highlight">SLIP Protocol</a><li><a href=#burst-protocol class="table-of-contents__link toc-highlight">Burst Protocol</a><li><a href=#fixed-protocol class="table-of-contents__link toc-highlight">Fixed Protocol</a><li><a href=#length-protocol class="table-of-contents__link toc-highlight">Length Protocol</a><li><a href=#terminated-protocol class="table-of-contents__link toc-highlight">Terminated Protocol</a><li><a href=#gems-protocol-enterprise class="table-of-contents__link toc-highlight">GEMS Protocol (Enterprise)</a><li><a href=#ccsds-cltu-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS CLTU Protocol (Enterprise)</a><li><a href=#ccsds-tctf-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS TCTF Protocol (Enterprise)</a><li><a href=#ccsds-tmtf-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS TMTF Protocol (Enterprise)</a><li><a href=#template-protocol-deprecated class="table-of-contents__link toc-highlight">Template Protocol (Deprecated)</a><li><a href=#preidentified-protocol class="table-of-contents__link toc-highlight">Preidentified Protocol</a></ul><li><a href=#helper-protocols class="table-of-contents__link toc-highlight">Helper Protocols</a><ul><li><a href=#cmdresponse-protocol class="table-of-contents__link toc-highlight">CmdResponse Protocol</a><ul><li><a href=#packet-definitions class="table-of-contents__link toc-highlight">Packet Definitions</a></ul><li><a href=#crc-protocol class="table-of-contents__link toc-highlight">CRC Protocol</a><li><a href=#ignore-packet-protocol class="table-of-contents__link toc-highlight">Ignore Packet Protocol</a></ul><li><a href=#custom-protocols class="table-of-contents__link toc-highlight">Custom Protocols</a><li><a href=#method-discussions class="table-of-contents__link toc-highlight">Method discussions</a><ul><li><a href=#initialize-or-init class="table-of-contents__link toc-highlight">initialize or <strong>init</strong></a><li><a href=#reset class="table-of-contents__link toc-highlight">reset</a><li><a href=#connect_reset class="table-of-contents__link toc-highlight">connect_reset</a><li><a href=#disconnect_reset class="table-of-contents__link toc-highlight">disconnect_reset</a><li><a href=#read_data class="table-of-contents__link toc-highlight">read_data</a><li><a href=#read_packet class="table-of-contents__link toc-highlight">read_packet</a><li><a href=#write_packet class="table-of-contents__link toc-highlight">write_packet</a><li><a href=#write_data class="table-of-contents__link toc-highlight">write_data</a><li><a href=#post_write_interface class="table-of-contents__link toc-highlight">post_write_interface</a><li><a href=#protocol_cmd class="table-of-contents__link toc-highlight">protocol_cmd</a></ul><li><a href=#examples class="table-of-contents__link toc-highlight">Examples</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>
157
+ <p>Please see the linked <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols target=_blank rel="noopener noreferrer">Ruby Protocol</a> and <a href=https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/interfaces/protocols target=_blank rel="noopener noreferrer">Python Protocol</a> code for examples of the above methods in action.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/protocols.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/configuration/interfaces><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Interfaces</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/accessors><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Accessors</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-delineation-protocols class="table-of-contents__link toc-highlight">Packet Delineation Protocols</a><ul><li><a href=#cobs-protocol class="table-of-contents__link toc-highlight">COBS Protocol</a><li><a href=#slip-protocol class="table-of-contents__link toc-highlight">SLIP Protocol</a><li><a href=#burst-protocol class="table-of-contents__link toc-highlight">Burst Protocol</a><li><a href=#fixed-protocol class="table-of-contents__link toc-highlight">Fixed Protocol</a><li><a href=#length-protocol class="table-of-contents__link toc-highlight">Length Protocol</a><li><a href=#terminated-protocol class="table-of-contents__link toc-highlight">Terminated Protocol</a><li><a href=#gems-protocol-enterprise class="table-of-contents__link toc-highlight">GEMS Protocol (Enterprise)</a><li><a href=#ccsds-cltu-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS CLTU Protocol (Enterprise)</a><li><a href=#ccsds-tctf-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS TCTF Protocol (Enterprise)</a><li><a href=#ccsds-tmtf-protocol-enterprise class="table-of-contents__link toc-highlight">CCSDS TMTF Protocol (Enterprise)</a><li><a href=#template-protocol-deprecated class="table-of-contents__link toc-highlight">Template Protocol (Deprecated)</a><li><a href=#preidentified-protocol class="table-of-contents__link toc-highlight">Preidentified Protocol</a></ul><li><a href=#helper-protocols class="table-of-contents__link toc-highlight">Helper Protocols</a><ul><li><a href=#command-response-protocol class="table-of-contents__link toc-highlight">Command Response Protocol</a><ul><li><a href=#packet-definitions class="table-of-contents__link toc-highlight">Packet Definitions</a></ul><li><a href=#crc-protocol class="table-of-contents__link toc-highlight">CRC Protocol</a><li><a href=#ignore-packet-protocol class="table-of-contents__link toc-highlight">Ignore Packet Protocol</a></ul><li><a href=#custom-protocols class="table-of-contents__link toc-highlight">Custom Protocols</a><li><a href=#method-discussions class="table-of-contents__link toc-highlight">Method discussions</a><ul><li><a href=#initialize-or-init class="table-of-contents__link toc-highlight">initialize or <strong>init</strong></a><li><a href=#reset class="table-of-contents__link toc-highlight">reset</a><li><a href=#connect_reset class="table-of-contents__link toc-highlight">connect_reset</a><li><a href=#disconnect_reset class="table-of-contents__link toc-highlight">disconnect_reset</a><li><a href=#read_data class="table-of-contents__link toc-highlight">read_data</a><li><a href=#read_packet class="table-of-contents__link toc-highlight">read_packet</a><li><a href=#write_packet class="table-of-contents__link toc-highlight">write_packet</a><li><a href=#write_data class="table-of-contents__link toc-highlight">write_data</a><li><a href=#post_write_interface class="table-of-contents__link toc-highlight">post_write_interface</a><li><a href=#protocol_cmd class="table-of-contents__link toc-highlight">protocol_cmd</a></ul><li><a href=#examples class="table-of-contents__link toc-highlight">Examples</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>