openc3-cosmos-tool-docs 5.19.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (429) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +1 -13
  3. data/tools/staticdocs/assets/css/styles.839a3ee9.css +1 -0
  4. data/tools/staticdocs/assets/images/add_tool-6919be6e6c05db133a8816a9fc03bf98b0789a8525da4cdaa7b041b25bf9edb8.png +0 -0
  5. data/tools/staticdocs/assets/images/array-c0c541246cb3f9e355acc5c510649c29116ce4d6eb8864b9ace48e9958b36421.png +0 -0
  6. data/tools/staticdocs/assets/images/backcolor-39ca0e2a25bd98fe1c9e067f026f3a719a760d3f14ccb404e2da3a0af4235760.png +0 -0
  7. data/tools/staticdocs/assets/images/block-14583c7d26c1a1c6553435d57015bc5282426f7aa176804867de223009a8d4d7.png +0 -0
  8. data/tools/staticdocs/assets/images/bordercolor-a3ac15f24f91c910fcc9c8bd195232205ec44da0b428b11b71108687ce6316d3.png +0 -0
  9. data/tools/staticdocs/assets/images/button-3f6fd69518f4b2c60b15605ca607cda8b596d4d5e804b867f09f750a47b6cbad.png +0 -0
  10. data/tools/staticdocs/assets/images/canvasdot-d634bed1905d13b0da41200e62781cea6e012b5d68fc914f4c11f512c9c4f7fd.png +0 -0
  11. data/tools/staticdocs/assets/images/canvasimage-6f6f83dc6d777fdff0b820287a96ad171a475fda2896c0a3b678b14984e496fd.png +0 -0
  12. data/tools/staticdocs/assets/images/canvasimagevalue-8c835310f99cebbb15ad34632c77370cf4cc9b95535040fa4723df8baedb5b57.png +0 -0
  13. data/tools/staticdocs/assets/images/canvaslabel-68ee99da9ef15924a2b5b41c60ba7de47382d036eece57574411839ff5ec14e4.png +0 -0
  14. data/tools/staticdocs/assets/images/canvaslabelvalue-43254b6647e626939e79ec7e0940e921582039af006e5024c952881ba196b165.png +0 -0
  15. data/tools/staticdocs/assets/images/canvasline-c5120da84530d4a60a04d40d5565daede656639808d1a456f430e9404a2d5bad.png +0 -0
  16. data/tools/staticdocs/assets/images/canvaslinevalue-5540d10997f723fd09b269b75997452622a3c4333ed4f25628747c1212699255.png +0 -0
  17. data/tools/staticdocs/assets/images/checkbutton-c263b840dcdbeca5cd886884fe8f24bedac7daac5a0ca224a1fb2cce3e24bdf6.png +0 -0
  18. data/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png +0 -0
  19. data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
  20. data/tools/staticdocs/assets/images/collect_states-5418d5b4cb901577f2cbdeccceb254dd2e5b81b1f2c975fb15b5fc679cf23dbf.png +0 -0
  21. data/tools/staticdocs/assets/images/combobox-6c8fa241aa7c5ccf31a42a2373dbd4f6f66d9a063e98ba111d5472b5c8e21590.png +0 -0
  22. data/tools/staticdocs/assets/images/command_history-ecc9b618661ad0aefa0700047a8ab3b094372f2aa427e9fcd270dcd352a30408.png +0 -0
  23. data/tools/staticdocs/assets/images/command_sender-83cf2e2343133c2883c405abd0b322f6d3d4a095c6ee800158a04c8eefe474ed.png +0 -0
  24. data/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png +0 -0
  25. data/tools/staticdocs/assets/images/date-d104f822ef7a1b99ade0a334e2e34c27fc6b1d087ed267f13280623a943113ce.png +0 -0
  26. data/tools/staticdocs/assets/images/formatvalue-8e2ddb6cec177fde1846d333d70168479a3bf67dd2b293764f938726b9e7cdf8.png +0 -0
  27. data/tools/staticdocs/assets/images/height-67268e562da2f9b2d0b9adc38d8fb2ba629504b09d798d8c26be9cfbfdad672a.png +0 -0
  28. data/tools/staticdocs/assets/images/history-04aebef1a0fdaaacc5042e5b835f850b48ea04f4fe50271d9bb57803b442d6cd.png +0 -0
  29. data/tools/staticdocs/assets/images/horizontal-11de51b6fc8baf057ca4f38a7f54a5302b58f30099331c22a074f012e53497aa.png +0 -0
  30. data/tools/staticdocs/assets/images/horizontalbox-ddf82f64de700286a742a71e0c1adebbc7e9822a0dff41139f41bc476e4fc4ce.png +0 -0
  31. data/tools/staticdocs/assets/images/horizontalline-0805762eadcc125ed6584a29a60e7cf8e2d76d13c6243e18eecbaba7a3803128.png +0 -0
  32. data/tools/staticdocs/assets/images/iframe-30d5a4104336b84d18ba538d668978a7986679431a7fe1fd0e3179fea08c074f.png +0 -0
  33. data/tools/staticdocs/assets/images/imageviewer-6149159e29a35cd6694926b344836ce034ce17cc019537028a80d95460eec405.png +0 -0
  34. data/tools/staticdocs/assets/images/inst_clear-48f37464d774363be4a5c1d30a48d4bc7803cb806a15d80dcd3741d7a9a37811.png +0 -0
  35. data/tools/staticdocs/assets/images/inst_collect-ef36e8a1e97fde625cde7a9c300c3db61aca30140f5431f089ce6a3e5da9d7f4.png +0 -0
  36. data/tools/staticdocs/assets/images/inst_collect_hazardous-02857bda2b5e7e821d3f42d3301962ede2bb4379c469a9d62f4a0e686336f0c4.png +0 -0
  37. data/tools/staticdocs/assets/images/interfaces-fa10646a27eb9045b70c2c485498a864bed1896ff171b7f31f8698288e08ae73.png +0 -0
  38. data/tools/staticdocs/assets/images/label-25a3052a497d0db7ebf84c788baedcd01d34f4b423aceee53d6d83639a128e82.png +0 -0
  39. data/tools/staticdocs/assets/images/labelled-b8d0f0a157f48e1fa98511f9177f962e69d1e0e8c24b37cf9f355671f9d13ab8.png +0 -0
  40. data/tools/staticdocs/assets/images/labelprogressbar-c3412db92b2f4e6af20233b085ee20915414d6c4da371398a3e8f36b84971cc7.png +0 -0
  41. data/tools/staticdocs/assets/images/labelsparkline-5985a0f034a5d2fb54b040612178ac9f0d5476eb76ca7e04cacc2618a9970c69.png +0 -0
  42. data/tools/staticdocs/assets/images/labelvalue-db97724272df4815b4ecc397974f91a62c31108b98ef0657716c670ca8128051.png +0 -0
  43. data/tools/staticdocs/assets/images/labelvaluedesc-2e174a9f3443ba971683dea9a33f8aa66d0248fb92a3aff41ec26b7424b5e68c.png +0 -0
  44. data/tools/staticdocs/assets/images/labelvaluelimitscolumn-47664affa9d88150ce257e90d32c61b314d7f0b6aa6da4f5e49152be2cce4ef7.png +0 -0
  45. data/tools/staticdocs/assets/images/labelvaluerangebar-641eba160b8ef7872557584de92f046d9e4411fae3280781f9b049265cc6dd52.png +0 -0
  46. data/tools/staticdocs/assets/images/led-d333a6c7e8b1bad13b7775142c74f94b1829ddedd38814d606b2d00e76707751.png +0 -0
  47. data/tools/staticdocs/assets/images/limitsbar-4f2758f846f6f8a1add81aeaf3b58e071792a6d2ccae9eb504e9c07ab8f8dae1.png +0 -0
  48. data/tools/staticdocs/assets/images/limitscolor-7f8e24e4f27f476c3b4c57393ab797268b86aa8ad8b6e7b83d72dd5bf3ca7952.png +0 -0
  49. data/tools/staticdocs/assets/images/limitscolumn-743800180e9558c86a4f5c5d949e2b8355420a98c85ef98a3320b09defa21fe6.png +0 -0
  50. data/tools/staticdocs/assets/images/linegraph-dc3cca59601beb3ea551bbd05e4e09b6cfabd1a7cbc93b757a7d4b22c478a75b.png +0 -0
  51. data/tools/staticdocs/assets/images/log_messages-6da2901ac63928daa3dcaf39a78ca9e455482c48d4ba917ee704f697e5210818.png +0 -0
  52. data/tools/staticdocs/assets/images/margin-4247b51c2c305cb961d08a807f30883b7fc6d9e3316c18174b86afe2356106dd.png +0 -0
  53. data/tools/staticdocs/assets/images/matrixbycolumns-74a67f236a97fffbdf7251fc98da2302a92df20ad16793a1617bc6f77380c9f6.png +0 -0
  54. data/tools/staticdocs/assets/images/microservices-805cc7d137958ac8183579cdb9a9845e7aef79db19723f0773f4ea4d957b48a1.png +0 -0
  55. data/tools/staticdocs/assets/images/mode_menu-04b9187b57a09ed12481a2699a86c7504fdc1c822579b4f762865ea90cb52dd3.png +0 -0
  56. data/tools/staticdocs/assets/images/named_widget-37362db8e310e5639be849d729fd637677f72330d676da4cd6baafc4b961331c.png +0 -0
  57. data/tools/staticdocs/assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png +0 -0
  58. data/tools/staticdocs/assets/images/padding-e8ceea8ec79def3b14d186971854c44883675d974409366b77c586eedd85025c.png +0 -0
  59. data/tools/staticdocs/assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png +0 -0
  60. data/tools/staticdocs/assets/images/progressbar-cc1095369de0d483c4a9b07ad3a76f9e966990b2aa68b2bc8177d7130ed382a7.png +0 -0
  61. data/tools/staticdocs/assets/images/radiobutton-9151f7cb0dae5120e51e05b5575981c143e19f350e84c7e190d3dd78aa80fae8.png +0 -0
  62. data/tools/staticdocs/assets/images/rangebar-ceae5a30609ab12625e29fd479e88fb3ba16eb12879976edc807da87547a275d.png +0 -0
  63. data/tools/staticdocs/assets/images/raw-63c1dd793f4a734e7d512bf4c0c3722831c38d5392a1a1b0cb77bbef4d16b96b.png +0 -0
  64. data/tools/staticdocs/assets/images/redis-4553b5b35292cca3df1fa08577f2175efef34e0fdfe512f30ca70785b086b24f.png +0 -0
  65. data/tools/staticdocs/assets/images/right_click-371e3683026c0bb2b27187277b4e99727c6b52965e0190a5f81335248f40ef9b.png +0 -0
  66. data/tools/staticdocs/assets/images/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png +0 -0
  67. data/tools/staticdocs/assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png +0 -0
  68. data/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png +0 -0
  69. data/tools/staticdocs/assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png +0 -0
  70. data/tools/staticdocs/assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png +0 -0
  71. data/tools/staticdocs/assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png +0 -0
  72. data/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png +0 -0
  73. data/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png +0 -0
  74. data/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png +0 -0
  75. data/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png +0 -0
  76. data/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png +0 -0
  77. data/tools/staticdocs/assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png +0 -0
  78. data/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png +0 -0
  79. data/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png +0 -0
  80. data/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png +0 -0
  81. data/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png +0 -0
  82. data/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png +0 -0
  83. data/tools/staticdocs/assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png +0 -0
  84. data/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png +0 -0
  85. data/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png +0 -0
  86. data/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png +0 -0
  87. data/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png +0 -0
  88. data/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png +0 -0
  89. data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
  90. data/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png +0 -0
  91. data/tools/staticdocs/assets/js/019369f3.8413befc.js +1 -0
  92. data/tools/staticdocs/assets/js/058ffc22.a4ceeb8e.js +1 -0
  93. data/tools/staticdocs/assets/js/0686a885.ae0a89e8.js +1 -0
  94. data/tools/staticdocs/assets/js/078dbab0.90ef4019.js +1 -0
  95. data/tools/staticdocs/assets/js/0f5d161c.1c827de2.js +1 -0
  96. data/tools/staticdocs/assets/js/0ff569c9.3b7f9c95.js +1 -0
  97. data/tools/staticdocs/assets/js/103cc3be.76716a45.js +1 -0
  98. data/tools/staticdocs/assets/js/13196248.18801ae0.js +1 -0
  99. data/tools/staticdocs/assets/js/13c1b4e4.4457fa9a.js +1 -0
  100. data/tools/staticdocs/assets/js/1602.1e622848.js +1 -0
  101. data/tools/staticdocs/assets/js/1e02e6a3.8e63f255.js +1 -0
  102. data/tools/staticdocs/assets/js/2047b354.9470f5c9.js +1 -0
  103. data/tools/staticdocs/assets/js/2124.0e1f26f5.js +1 -0
  104. data/tools/staticdocs/assets/js/22b3ac48.ac895789.js +1 -0
  105. data/tools/staticdocs/assets/js/26b8abb2.45d268b1.js +1 -0
  106. data/tools/staticdocs/assets/js/2bb7bf90.471e10a1.js +1 -0
  107. data/tools/staticdocs/assets/js/3040.18a0bb2a.js +4 -0
  108. data/tools/staticdocs/assets/js/3687.6fa52db1.js +101 -0
  109. data/tools/staticdocs/assets/js/3dd7ef3b.d8bb37a8.js +1 -0
  110. data/tools/staticdocs/assets/js/40365d27.5f8a5da7.js +1 -0
  111. data/tools/staticdocs/assets/js/411898ad.c8f67fde.js +1 -0
  112. data/tools/staticdocs/assets/js/42170351.86617d4a.js +1 -0
  113. data/tools/staticdocs/assets/js/4303.a84f454a.js +1 -0
  114. data/tools/staticdocs/assets/js/43652efd.0c473c25.js +1 -0
  115. data/tools/staticdocs/assets/js/53ca7c5b.f0e35da3.js +1 -0
  116. data/tools/staticdocs/assets/js/54d0d530.9ace531c.js +1 -0
  117. data/tools/staticdocs/assets/js/5b233ba7.565c0c28.js +1 -0
  118. data/tools/staticdocs/assets/js/5bc719f6.80b7b43c.js +1 -0
  119. data/tools/staticdocs/assets/js/5c6ce5ec.ed839e0d.js +1 -0
  120. data/tools/staticdocs/assets/js/5e3ed378.048e258b.js +1 -0
  121. data/tools/staticdocs/assets/js/5fe211ef.96109971.js +1 -0
  122. data/tools/staticdocs/assets/js/62df909c.dd5f3a0c.js +1 -0
  123. data/tools/staticdocs/assets/js/630e5448.699a9dec.js +1 -0
  124. data/tools/staticdocs/assets/js/6831b732.4008a669.js +1 -0
  125. data/tools/staticdocs/assets/js/696b4199.34aa1d77.js +1 -0
  126. data/tools/staticdocs/assets/js/6b210247.d37e3087.js +1 -0
  127. data/tools/staticdocs/assets/js/6b65133b.f71c0e94.js +1 -0
  128. data/tools/staticdocs/assets/js/6f92e431.c98e31e0.js +1 -0
  129. data/tools/staticdocs/assets/js/72c6d8a8.1053fbd7.js +1 -0
  130. data/tools/staticdocs/assets/js/75897369.522ccdd7.js +1 -0
  131. data/tools/staticdocs/assets/js/75e64983.6b588c87.js +1 -0
  132. data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
  133. data/tools/staticdocs/assets/js/7f5b2696.72e3b019.js +1 -0
  134. data/tools/staticdocs/assets/js/80c97f38.5a408d9c.js +1 -0
  135. data/tools/staticdocs/assets/js/867640d5.866fe67b.js +1 -0
  136. data/tools/staticdocs/assets/js/89e76475.b4e9da15.js +1 -0
  137. data/tools/staticdocs/assets/js/8f7843ee.59da8025.js +1 -0
  138. data/tools/staticdocs/assets/js/9424f0b3.cc8aa06e.js +1 -0
  139. data/tools/staticdocs/assets/js/97535711.94a5b402.js +1 -0
  140. data/tools/staticdocs/assets/js/99581c43.ebea1d08.js +1 -0
  141. data/tools/staticdocs/assets/js/9d6e81d0.4bc52207.js +1 -0
  142. data/tools/staticdocs/assets/js/{9fb6059a.a5107afb.js → 9fb6059a.57936fbe.js} +1 -1
  143. data/tools/staticdocs/assets/js/a677c089.d8d7a8f5.js +1 -0
  144. data/tools/staticdocs/assets/js/a9987364.2aa836fd.js +1 -0
  145. data/tools/staticdocs/assets/js/aa6b6c1b.4f484861.js +1 -0
  146. data/tools/staticdocs/assets/js/b4596165.a5fe2cea.js +1 -0
  147. data/tools/staticdocs/assets/js/b6d70f94.5df56282.js +1 -0
  148. data/tools/staticdocs/assets/js/b9f60ba6.cdb4a698.js +1 -0
  149. data/tools/staticdocs/assets/js/bd0034eb.5fb449fc.js +1 -0
  150. data/tools/staticdocs/assets/js/c24eae19.f419c8fb.js +1 -0
  151. data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +1 -0
  152. data/tools/staticdocs/assets/js/c5388ca4.32f8f561.js +1 -0
  153. data/tools/staticdocs/assets/js/cb8c3f08.9264e5dd.js +1 -0
  154. data/tools/staticdocs/assets/js/cd879be4.aa3c877c.js +1 -0
  155. data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +1 -0
  156. data/tools/staticdocs/assets/js/d1b923aa.de9e8fd6.js +1 -0
  157. data/tools/staticdocs/assets/js/d1bfc316.82dd17ab.js +1 -0
  158. data/tools/staticdocs/assets/js/d24bf9b6.1cb515f4.js +1 -0
  159. data/tools/staticdocs/assets/js/d57a4b5d.09769a64.js +1 -0
  160. data/tools/staticdocs/assets/js/d5d77c37.1704d750.js +1 -0
  161. data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js +1 -0
  162. data/tools/staticdocs/assets/js/d8ca4191.1861d710.js +1 -0
  163. data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js +1 -0
  164. data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js +1 -0
  165. data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js +1 -0
  166. data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js +1 -0
  167. data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js +1 -0
  168. data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js +1 -0
  169. data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js +1 -0
  170. data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js +1 -0
  171. data/tools/staticdocs/assets/js/fd886806.fa25adc4.js +1 -0
  172. data/tools/staticdocs/assets/js/main.1a59b278.js +36 -0
  173. data/tools/staticdocs/assets/js/runtime~main.25e99a76.js +1 -0
  174. data/tools/staticdocs/docs/configuration/accessors.html +85 -0
  175. data/tools/staticdocs/docs/configuration/command.html +149 -158
  176. data/tools/staticdocs/docs/configuration/format.html +28 -40
  177. data/tools/staticdocs/docs/configuration/interfaces.html +119 -64
  178. data/tools/staticdocs/docs/configuration/plugins.html +234 -225
  179. data/tools/staticdocs/docs/configuration/protocols.html +106 -92
  180. data/tools/staticdocs/docs/configuration/ssl-tls.html +34 -46
  181. data/tools/staticdocs/docs/configuration/table.html +88 -100
  182. data/tools/staticdocs/docs/configuration/target.html +29 -41
  183. data/tools/staticdocs/docs/configuration/telemetry-screens.html +374 -316
  184. data/tools/staticdocs/docs/configuration/telemetry.html +136 -142
  185. data/tools/staticdocs/docs/configuration.html +1 -13
  186. data/tools/staticdocs/docs/development/curl.html +17 -29
  187. data/tools/staticdocs/docs/development/developing.html +24 -36
  188. data/tools/staticdocs/docs/development/json-api.html +26 -38
  189. data/tools/staticdocs/docs/development/log-structure.html +19 -31
  190. data/tools/staticdocs/docs/development/roadmap.html +26 -44
  191. data/tools/staticdocs/docs/development/streaming-api.html +10 -22
  192. data/tools/staticdocs/docs/development/testing.html +23 -27
  193. data/tools/staticdocs/docs/development.html +1 -13
  194. data/tools/staticdocs/docs/getting-started/generators.html +37 -49
  195. data/tools/staticdocs/docs/getting-started/gettingstarted.html +45 -56
  196. data/tools/staticdocs/docs/getting-started/installation.html +24 -36
  197. data/tools/staticdocs/docs/getting-started/key_concepts.html +32 -44
  198. data/tools/staticdocs/docs/getting-started/podman.html +25 -37
  199. data/tools/staticdocs/docs/getting-started/requirements.html +32 -44
  200. data/tools/staticdocs/docs/getting-started/upgrading.html +134 -24
  201. data/tools/staticdocs/docs/getting-started.html +1 -13
  202. data/tools/staticdocs/docs/guides/bridges.html +17 -30
  203. data/tools/staticdocs/docs/guides/cfs.html +46 -58
  204. data/tools/staticdocs/docs/guides/custom-widgets.html +17 -29
  205. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -15
  206. data/tools/staticdocs/docs/guides/local-mode.html +16 -28
  207. data/tools/staticdocs/docs/guides/logging.html +12 -24
  208. data/tools/staticdocs/docs/guides/monitoring.html +18 -30
  209. data/tools/staticdocs/docs/guides/performance.html +21 -33
  210. data/tools/staticdocs/docs/guides/raspberrypi.html +16 -28
  211. data/tools/staticdocs/docs/guides/script-writing.html +108 -120
  212. data/tools/staticdocs/docs/guides/scripting-api.html +606 -615
  213. data/tools/staticdocs/docs/guides.html +1 -13
  214. data/tools/staticdocs/docs/meta/contributing.html +14 -26
  215. data/tools/staticdocs/docs/meta/licenses.html +36 -25
  216. data/tools/staticdocs/docs/meta/philosophy.html +3 -15
  217. data/tools/staticdocs/docs/meta/xtce.html +13 -25
  218. data/tools/staticdocs/docs/meta.html +1 -13
  219. data/tools/staticdocs/docs/privacy.html +19 -31
  220. data/tools/staticdocs/docs/tools/admin.html +36 -0
  221. data/tools/staticdocs/docs/tools/autonomic.html +22 -34
  222. data/tools/staticdocs/docs/tools/bucket-explorer.html +10 -22
  223. data/tools/staticdocs/docs/tools/calendar.html +21 -33
  224. data/tools/staticdocs/docs/tools/cmd-sender.html +16 -28
  225. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +27 -36
  226. data/tools/staticdocs/docs/tools/command_history.html +10 -0
  227. data/tools/staticdocs/docs/tools/data-extractor.html +29 -41
  228. data/tools/staticdocs/docs/tools/data-viewer.html +11 -23
  229. data/tools/staticdocs/docs/tools/handbooks.html +4 -16
  230. data/tools/staticdocs/docs/tools/limits-monitor.html +18 -30
  231. data/tools/staticdocs/docs/tools/packet-viewer.html +16 -28
  232. data/tools/staticdocs/docs/tools/script-runner.html +44 -50
  233. data/tools/staticdocs/docs/tools/table-manager.html +16 -28
  234. data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -33
  235. data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -28
  236. data/tools/staticdocs/docs/tools.html +1 -13
  237. data/tools/staticdocs/docs.html +12 -24
  238. data/tools/staticdocs/img/admin/add_tool.png +0 -0
  239. data/tools/staticdocs/img/admin/interfaces.png +0 -0
  240. data/tools/staticdocs/img/admin/microservices.png +0 -0
  241. data/tools/staticdocs/img/admin/packages.png +0 -0
  242. data/tools/staticdocs/img/admin/plugins.png +0 -0
  243. data/tools/staticdocs/img/admin/redis.png +0 -0
  244. data/tools/staticdocs/img/admin/routers.png +0 -0
  245. data/tools/staticdocs/img/admin/secrets.png +0 -0
  246. data/tools/staticdocs/img/admin/settings1.png +0 -0
  247. data/tools/staticdocs/img/admin/settings2.png +0 -0
  248. data/tools/staticdocs/img/admin/targets.png +0 -0
  249. data/tools/staticdocs/img/admin/tools.png +0 -0
  250. data/tools/staticdocs/img/cmd_tlm_server/cmd_authority.png +0 -0
  251. data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
  252. data/tools/staticdocs/img/cmd_tlm_server/critical_cmd_sender.png +0 -0
  253. data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
  254. data/tools/staticdocs/img/command_history/command_history.png +0 -0
  255. data/tools/staticdocs/img/command_sender/collect_states.png +0 -0
  256. data/tools/staticdocs/img/command_sender/command_sender.png +0 -0
  257. data/tools/staticdocs/img/command_sender/history.png +0 -0
  258. data/tools/staticdocs/img/command_sender/inst_clear.png +0 -0
  259. data/tools/staticdocs/img/command_sender/inst_collect.png +0 -0
  260. data/tools/staticdocs/img/command_sender/inst_collect_hazardous.png +0 -0
  261. data/tools/staticdocs/img/command_sender/mode_menu.png +0 -0
  262. data/tools/staticdocs/img/script_runner/right_click.png +0 -0
  263. data/tools/staticdocs/img/telemetry_viewer/widgets/array.png +0 -0
  264. data/tools/staticdocs/img/telemetry_viewer/widgets/backcolor.png +0 -0
  265. data/tools/staticdocs/img/telemetry_viewer/widgets/block.png +0 -0
  266. data/tools/staticdocs/img/telemetry_viewer/widgets/bordercolor.png +0 -0
  267. data/tools/staticdocs/img/telemetry_viewer/widgets/button.png +0 -0
  268. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasdot.png +0 -0
  269. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimage.png +0 -0
  270. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimagevalue.png +0 -0
  271. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabel.png +0 -0
  272. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabelvalue.png +0 -0
  273. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasline.png +0 -0
  274. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslinevalue.png +0 -0
  275. data/tools/staticdocs/img/telemetry_viewer/widgets/checkbutton.png +0 -0
  276. data/tools/staticdocs/img/telemetry_viewer/widgets/combobox.png +0 -0
  277. data/tools/staticdocs/img/telemetry_viewer/widgets/date.png +0 -0
  278. data/tools/staticdocs/img/telemetry_viewer/widgets/formatvalue.png +0 -0
  279. data/tools/staticdocs/img/telemetry_viewer/widgets/height.png +0 -0
  280. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontal.png +0 -0
  281. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
  282. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalline.png +0 -0
  283. data/tools/staticdocs/img/telemetry_viewer/widgets/iframe.png +0 -0
  284. data/tools/staticdocs/img/telemetry_viewer/widgets/imageviewer.png +0 -0
  285. data/tools/staticdocs/img/telemetry_viewer/widgets/label.png +0 -0
  286. data/tools/staticdocs/img/telemetry_viewer/widgets/labelled.png +0 -0
  287. data/tools/staticdocs/img/telemetry_viewer/widgets/labelprogressbar.png +0 -0
  288. data/tools/staticdocs/img/telemetry_viewer/widgets/labelsparkline.png +0 -0
  289. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvalue.png +0 -0
  290. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluedesc.png +0 -0
  291. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluelimitscolumn.png +0 -0
  292. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluerangebar.png +0 -0
  293. data/tools/staticdocs/img/telemetry_viewer/widgets/led.png +0 -0
  294. data/tools/staticdocs/img/telemetry_viewer/widgets/limitsbar.png +0 -0
  295. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolor.png +0 -0
  296. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolumn.png +0 -0
  297. data/tools/staticdocs/img/telemetry_viewer/widgets/linegraph.png +0 -0
  298. data/tools/staticdocs/img/telemetry_viewer/widgets/margin.png +0 -0
  299. data/tools/staticdocs/img/telemetry_viewer/widgets/matrixbycolumns.png +0 -0
  300. data/tools/staticdocs/img/telemetry_viewer/widgets/named_widget.png +0 -0
  301. data/tools/staticdocs/img/telemetry_viewer/widgets/padding.png +0 -0
  302. data/tools/staticdocs/img/telemetry_viewer/widgets/progressbar.png +0 -0
  303. data/tools/staticdocs/img/telemetry_viewer/widgets/radiobutton.png +0 -0
  304. data/tools/staticdocs/img/telemetry_viewer/widgets/rangebar.png +0 -0
  305. data/tools/staticdocs/img/telemetry_viewer/widgets/raw.png +0 -0
  306. data/tools/staticdocs/img/telemetry_viewer/widgets/rollup.png +0 -0
  307. data/tools/staticdocs/img/telemetry_viewer/widgets/scrollwindow.png +0 -0
  308. data/tools/staticdocs/img/telemetry_viewer/widgets/signal.png +0 -0
  309. data/tools/staticdocs/img/telemetry_viewer/widgets/spacer.png +0 -0
  310. data/tools/staticdocs/img/telemetry_viewer/widgets/sparkline.png +0 -0
  311. data/tools/staticdocs/img/telemetry_viewer/widgets/subsetting.png +0 -0
  312. data/tools/staticdocs/img/telemetry_viewer/widgets/tabbook.png +0 -0
  313. data/tools/staticdocs/img/telemetry_viewer/widgets/tabitem.png +0 -0
  314. data/tools/staticdocs/img/telemetry_viewer/widgets/textbox.png +0 -0
  315. data/tools/staticdocs/img/telemetry_viewer/widgets/textcolor.png +0 -0
  316. data/tools/staticdocs/img/telemetry_viewer/widgets/textfield.png +0 -0
  317. data/tools/staticdocs/img/telemetry_viewer/widgets/time.png +0 -0
  318. data/tools/staticdocs/img/telemetry_viewer/widgets/title.png +0 -0
  319. data/tools/staticdocs/img/telemetry_viewer/widgets/value.png +0 -0
  320. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitsbar.png +0 -0
  321. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitscolumn.png +0 -0
  322. data/tools/staticdocs/img/telemetry_viewer/widgets/valuerangebar.png +0 -0
  323. data/tools/staticdocs/img/telemetry_viewer/widgets/vertical.png +0 -0
  324. data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
  325. data/tools/staticdocs/img/telemetry_viewer/widgets/width.png +0 -0
  326. data/tools/staticdocs/index.html +1 -13
  327. data/tools/staticdocs/lunr-index-1734474862542.json +1 -0
  328. data/tools/staticdocs/lunr-index.json +1 -1
  329. data/tools/staticdocs/markdown-page.html +2 -14
  330. data/tools/staticdocs/search-doc-1734474862542.json +1 -0
  331. data/tools/staticdocs/search-doc.json +1 -1
  332. data/tools/staticdocs/sitemap.xml +1 -1
  333. metadata +256 -99
  334. data/tools/staticdocs/assets/css/styles.80ddca08.css +0 -1
  335. data/tools/staticdocs/assets/images/cmd_authority-51594401bfa6d8cc5849aae05b4d2af838360f8a3329f9746aa1307fe3091402.png +0 -0
  336. data/tools/staticdocs/assets/images/cmd_tlm_server-727ea478568988b10e4be4a3ba7255dd48ec56f6ab6444c6c1e32497fe478681.png +0 -0
  337. data/tools/staticdocs/assets/images/collect_states-565ae4b6d02449850585afd7ce35982711d4d677f5a04c1332b2c176f1ec3a25.png +0 -0
  338. data/tools/staticdocs/assets/images/command_sender-bb1543bde21fc1963405de5251d16a80a0c3a1bf5adb5fb78145d4995e2fe541.png +0 -0
  339. data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
  340. data/tools/staticdocs/assets/images/inst_clear-2d5f985c879e8b917fedacdb8c6552bbd383231bf5c8ab8e560e77df4e050026.png +0 -0
  341. data/tools/staticdocs/assets/images/inst_collect-81bc422b3b33c5ebcbe4c2f489c730b32ab0d6ea6c7f81cc79d9f6bc03e9db15.png +0 -0
  342. data/tools/staticdocs/assets/images/inst_collect_hazardous-a8fb19ea296354a0cd276da1e0ad82f74479eea4e7e204fcf64b779596f2c092.png +0 -0
  343. data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
  344. data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
  345. data/tools/staticdocs/assets/js/019369f3.727d87f1.js +0 -1
  346. data/tools/staticdocs/assets/js/058ffc22.f2d69d72.js +0 -1
  347. data/tools/staticdocs/assets/js/0686a885.83641127.js +0 -1
  348. data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +0 -1
  349. data/tools/staticdocs/assets/js/0f5d161c.9d01fab0.js +0 -1
  350. data/tools/staticdocs/assets/js/0ff569c9.aa4daee5.js +0 -1
  351. data/tools/staticdocs/assets/js/103cc3be.537144c5.js +0 -1
  352. data/tools/staticdocs/assets/js/13196248.6b49e93d.js +0 -1
  353. data/tools/staticdocs/assets/js/13c1b4e4.22a0b1d4.js +0 -1
  354. data/tools/staticdocs/assets/js/1e02e6a3.0445f325.js +0 -1
  355. data/tools/staticdocs/assets/js/2047b354.25d11993.js +0 -1
  356. data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +0 -1
  357. data/tools/staticdocs/assets/js/2601.ca992ab9.js +0 -1
  358. data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +0 -1
  359. data/tools/staticdocs/assets/js/2bb7bf90.633f7a6c.js +0 -1
  360. data/tools/staticdocs/assets/js/3917.a6366d59.js +0 -1
  361. data/tools/staticdocs/assets/js/3dd7ef3b.d55880a8.js +0 -1
  362. data/tools/staticdocs/assets/js/40365d27.4b4b2ccd.js +0 -1
  363. data/tools/staticdocs/assets/js/411898ad.1d6a609d.js +0 -1
  364. data/tools/staticdocs/assets/js/42170351.d7f6034b.js +0 -1
  365. data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +0 -1
  366. data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +0 -1
  367. data/tools/staticdocs/assets/js/54d0d530.fa34b0b0.js +0 -1
  368. data/tools/staticdocs/assets/js/5723.f6123e37.js +0 -1
  369. data/tools/staticdocs/assets/js/5778.7d36f1c2.js +0 -1
  370. data/tools/staticdocs/assets/js/5b233ba7.6fdd6b6c.js +0 -1
  371. data/tools/staticdocs/assets/js/5bc719f6.daa2a049.js +0 -1
  372. data/tools/staticdocs/assets/js/5c6ce5ec.61a9cae2.js +0 -1
  373. data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +0 -1
  374. data/tools/staticdocs/assets/js/5fe211ef.0b54b37a.js +0 -1
  375. data/tools/staticdocs/assets/js/62df909c.906d9999.js +0 -1
  376. data/tools/staticdocs/assets/js/630e5448.6fea087c.js +0 -1
  377. data/tools/staticdocs/assets/js/6831b732.60c3c6d5.js +0 -1
  378. data/tools/staticdocs/assets/js/696b4199.a5ae3d65.js +0 -1
  379. data/tools/staticdocs/assets/js/6b210247.aaa91da1.js +0 -1
  380. data/tools/staticdocs/assets/js/6b65133b.76b83e83.js +0 -1
  381. data/tools/staticdocs/assets/js/6f92e431.d02304f0.js +0 -1
  382. data/tools/staticdocs/assets/js/72c6d8a8.be25aaac.js +0 -1
  383. data/tools/staticdocs/assets/js/75897369.7b31b03e.js +0 -1
  384. data/tools/staticdocs/assets/js/75e64983.6ef0928b.js +0 -1
  385. data/tools/staticdocs/assets/js/7760.7f593c4f.js +0 -2
  386. data/tools/staticdocs/assets/js/7760.7f593c4f.js.LICENSE.txt +0 -61
  387. data/tools/staticdocs/assets/js/7f5b2696.60735273.js +0 -1
  388. data/tools/staticdocs/assets/js/867640d5.48133ad5.js +0 -1
  389. data/tools/staticdocs/assets/js/89e76475.13ce283b.js +0 -1
  390. data/tools/staticdocs/assets/js/8f7843ee.7a68246a.js +0 -1
  391. data/tools/staticdocs/assets/js/9424f0b3.ea51e6e5.js +0 -1
  392. data/tools/staticdocs/assets/js/97535711.5311ddd9.js +0 -1
  393. data/tools/staticdocs/assets/js/99581c43.64e9c551.js +0 -1
  394. data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +0 -1
  395. data/tools/staticdocs/assets/js/a507c363.d2cc5d72.js +0 -1
  396. data/tools/staticdocs/assets/js/a677c089.7877e85d.js +0 -1
  397. data/tools/staticdocs/assets/js/a9987364.0358fb0b.js +0 -1
  398. data/tools/staticdocs/assets/js/aa6b6c1b.9f3252e1.js +0 -1
  399. data/tools/staticdocs/assets/js/b4596165.daa24b72.js +0 -1
  400. data/tools/staticdocs/assets/js/b6d70f94.19c327f0.js +0 -1
  401. data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +0 -1
  402. data/tools/staticdocs/assets/js/bd0034eb.6691ccc4.js +0 -1
  403. data/tools/staticdocs/assets/js/c24eae19.503774e8.js +0 -1
  404. data/tools/staticdocs/assets/js/c2598f55.c5a1bac3.js +0 -1
  405. data/tools/staticdocs/assets/js/c5388ca4.f526bb0c.js +0 -1
  406. data/tools/staticdocs/assets/js/cb8c3f08.b82ad06f.js +0 -1
  407. data/tools/staticdocs/assets/js/cd879be4.f956406f.js +0 -1
  408. data/tools/staticdocs/assets/js/ce89ef36.aa518a52.js +0 -1
  409. data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +0 -1
  410. data/tools/staticdocs/assets/js/d1bfc316.28d99aa4.js +0 -1
  411. data/tools/staticdocs/assets/js/d24bf9b6.6c422113.js +0 -1
  412. data/tools/staticdocs/assets/js/d57a4b5d.8f23a506.js +0 -1
  413. data/tools/staticdocs/assets/js/d5d77c37.fb296e02.js +0 -1
  414. data/tools/staticdocs/assets/js/d8ca4191.2349d796.js +0 -1
  415. data/tools/staticdocs/assets/js/d9b92eba.8f82360d.js +0 -1
  416. data/tools/staticdocs/assets/js/db8fa1d0.b0500934.js +0 -1
  417. data/tools/staticdocs/assets/js/dc5f7beb.e3a82d1e.js +0 -1
  418. data/tools/staticdocs/assets/js/dfbae5fd.d1484e14.js +0 -1
  419. data/tools/staticdocs/assets/js/e501b0d1.0b407477.js +0 -1
  420. data/tools/staticdocs/assets/js/ebec1ccb.a1b5fc97.js +0 -1
  421. data/tools/staticdocs/assets/js/f15615f1.ee14b7d6.js +0 -1
  422. data/tools/staticdocs/assets/js/fd886806.4a41fa80.js +0 -1
  423. data/tools/staticdocs/assets/js/main.a3784266.js +0 -2
  424. data/tools/staticdocs/assets/js/main.a3784266.js.LICENSE.txt +0 -71
  425. data/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js +0 -1
  426. data/tools/staticdocs/docs/development/host-install.html +0 -38
  427. data/tools/staticdocs/docs/v5/host-install/index.html +0 -11
  428. data/tools/staticdocs/lunr-index-1727813111453.json +0 -1
  429. data/tools/staticdocs/search-doc-1727813111453.json +0 -1
data/tools/staticdocs/docs/configuration/interfaces.html CHANGED
@@ -1,16 +1,121 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/interfaces" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.5.2">
6
- <title data-rh="true">Interfaces | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces"><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="Interfaces | OpenC3 Docs"><meta data-rh="true" name="description" content="Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file."><meta data-rh="true" property="og:description" content="Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.a3784266.js" defer="defer"></script>
9
- </head>
10
- <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Interfaces</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Interfaces</h1></header><p>Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level <a href="/tools/staticdocs/docs/configuration/plugins#interface-1">INTERFACE</a> keyword in the plugin.txt file.</p>
12
- <p>Interface classes provide the code that COSMOS uses to receive real-time telemetry from targets and to send commands to targets. The interface that a target uses could be anything (TCP/IP, serial, GPIB, Firewire, etc.), therefore it is important that this is a customizable portion of any reusable Command and Telemetry System. Fortunately the most common form of interfaces are over TCP/IP sockets, and COSMOS provides interface solutions for these. This guide will discuss how to use these interface classes, and how to create your own. Note that in most cases you can extend interfaces with <a href="/tools/staticdocs/docs/configuration/protocols">Protocols</a> rather than implementing a new interface.</p>
13
- <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Interface and Routers Are Very Similar</div><div class="admonitionContent_bl22"><p>Note that Interfaces and Routers are very similar and share the same configuration parameters. Routers are simply Interfaces which route an existing Interface&#x27;s telemetry data out to the connected target and routes the connected target&#x27;s commands back to the original Interface&#x27;s target.</p></div></div>
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/interfaces" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Interfaces | 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/interfaces><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="Interfaces | OpenC3 Docs"><meta data-rh=true name=description content="Built-in COSMOS interfaces including how to create one"><meta data-rh=true property=og:description content="Built-in COSMOS interfaces 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/interfaces><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/interfaces hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.25e99a76.js defer></script><script src=/tools/staticdocs/assets/js/main.1a59b278.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",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><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li 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 style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li 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 menu__link--active" aria-current=page 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 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/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 itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Interfaces</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Interfaces</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview">​</a></h2>
2
+ <p>Interfaces are the connection to the external embedded systems called <a href=/tools/staticdocs/docs/configuration/target>targets</a>. Interfaces are defined by the top level <a href=/tools/staticdocs/docs/configuration/plugins#interface-1>INTERFACE</a> keyword in the plugin.txt file.</p>
3
+ <p>Interface classes provide the code that COSMOS uses to receive real-time telemetry from targets and to send commands to targets. The interface that a target uses could be anything (TCP/IP, serial, MQTT, SNMP, etc.), therefore it is important that this is a customizable portion of any reusable Command and Telemetry System. Fortunately the most common form of interfaces are over TCP/IP sockets, and COSMOS provides interface solutions for these. This guide will discuss how to use these interface classes, and how to create your own. Note that in most cases you can extend interfaces with <a href=/tools/staticdocs/docs/configuration/protocols>Protocols</a> rather than implementing a new interface.</p>
4
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Interface and Routers Are Very Similar</div><div class=admonitionContent_bl22><p>Note that Interfaces and Routers are very similar and share the same configuration parameters. Routers are simply Interfaces which route an existing Interface's telemetry data out to the connected target and routes the connected target's commands back to the original Interface's target.</div></div>
5
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=protocols>Protocols<a href=#protocols class=hash-link aria-label="Direct link to Protocols" title="Direct link to Protocols">​</a></h3>
6
+ <p>Protocols define the behaviour of an Interface, including differentiating packet boundaries and modifying data as necessary. See <a href=/tools/staticdocs/docs/configuration/protocols>Protocols</a> for more information.</p>
7
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=accessors>Accessors<a href=#accessors class=hash-link aria-label="Direct link to Accessors" title="Direct link to Accessors">​</a></h3>
8
+ <p>Accessors are responsible for reading and writing the buffer which is transmitted by the interface to the target. See <a href=/tools/staticdocs/docs/configuration/accessors>Accessors</a> for more information.</p>
9
+ <p>For more information about how Interfaces fit with Protocols and Accessors see <a href=https://www.openc3.com/news/interoperability-without-standards target=_blank rel="noopener noreferrer">Interoperability Without Standards</a>.</p>
10
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=provided-interfaces>Provided Interfaces<a href=#provided-interfaces class=hash-link aria-label="Direct link to Provided Interfaces" title="Direct link to Provided Interfaces">​</a></h2>
11
+ <p>COSMOS provides the following interfaces: TCPIP Client, TCPIP Server, UDP, HTTP Client, HTTP Server, MQTT and Serial. The interface to use is defined by the <a href=/tools/staticdocs/docs/configuration/plugins#interface>INTERFACE</a> and <a href=/tools/staticdocs/docs/configuration/plugins#router>ROUTER</a> keywords. See <a href=/tools/staticdocs/docs/configuration/plugins#interface-modifiers>Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword.</p>
12
+ <p>COSMOS Enterprise provides the following interfaces: SNMP, SNMP Trap, GEMS, InfluxDB.</p>
13
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tcpip-client-interface>TCPIP Client Interface<a href=#tcpip-client-interface class=hash-link aria-label="Direct link to TCPIP Client Interface" title="Direct link to TCPIP Client Interface">​</a></h3>
14
+ <p>The TCPIP client interface connects to a TCPIP socket to send commands and receive telemetry. This interface is used for targets which open a socket and wait for a connection. This is the most common type of interface.</p>
15
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Host<td>Machine name to connect to<td>Yes<tr><td>Write Port<td>Port to write commands to (can be the same as read port). Pass nil / None to make the interface read only.<td>Yes<tr><td>Read Port<td>Port to read telemetry from (can be the same as write port). Pass nil / None to make the interface write only.<td>Yes<tr><td>Write Timeout<td>Number of seconds to wait before aborting the write<td>Yes<tr><td>Read Timeout<td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.<td>Yes<tr><td>Protocol Type<td>See Protocols.<td>No<tr><td>Protocol Arguments<td>See Protocols for the arguments each stream protocol takes.<td>No</table>
16
+ <p>plugin.txt Ruby Examples:</p>
17
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
18
+ <p>plugin.txt Python Examples:</p>
19
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> None </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
20
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tcpip-server-interface>TCPIP Server Interface<a href=#tcpip-server-interface class=hash-link aria-label="Direct link to TCPIP Server Interface" title="Direct link to TCPIP Server Interface">​</a></h3>
21
+ <p>The TCPIP server interface creates a TCPIP server which listens for incoming connections and dynamically creates sockets which communicate with the target. This interface is used for targets which open a socket and try to connect to a server.</p>
22
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Write Port<td>Port to write commands to (can be the same as read port)<td>Yes<tr><td>Read Port<td>Port to read telemetry from (can be the same as write port)<td>Yes<tr><td>Write Timeout<td>Number of seconds to wait before aborting the write<td>Yes<tr><td>Read Timeout<td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.<td>Yes<tr><td>Protocol Type<td>See Protocols.<td>No<tr><td>Protocol Arguments<td>See Protocols for the arguments each stream protocol takes.<td>No</table>
23
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options>Interface Options<a href=#interface-options class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
24
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
25
+ <table><thead><tr><th>Option<th>Description<th>Default<tbody><tr><td>LISTEN_ADDRESS<td>IP address to accept connections on<td>0.0.0.0</table>
26
+ <p>plugin.txt Ruby Examples:</p>
27
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LISTEN_ADDRESS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">127.0</span><span class="token number" style="color:rgb(247, 140, 108)">.0</span><span class="token number" style="color:rgb(247, 140, 108)">.1</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
28
+ <p>plugin.txt Python Examples:</p>
29
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> None </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
30
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=udp-interface>UDP Interface<a href=#udp-interface class=hash-link aria-label="Direct link to UDP Interface" title="Direct link to UDP Interface">​</a></h3>
31
+ <p>The UDP interface uses UDP packets to send and receive telemetry from the target.</p>
32
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Host<td>Host name or IP address of the machine to send and receive data with<td>Yes<td><tr><td>Write Dest Port<td>Port on the remote machine to send commands to<td>Yes<td><tr><td>Read Port<td>Port on the remote machine to read telemetry from<td>Yes<td><tr><td>Write Source Port<td>Port on the local machine to send commands from<td>No<td>nil (socket is not bound to an outgoing port)<tr><td>Interface Address<td>If the remote machine supports multicast the interface address is used to configure the outgoing multicast address<td>No<td>nil (not used)<tr><td>TTL<td>Time to Live. The number of intermediate routers allowed before dropping the packet.<td>No<td>128 (Windows)<tr><td>Write Timeout<td>Number of seconds to wait before aborting the write<td>No<td>10.0<tr><td>Read Timeout<td>Number of seconds to wait before aborting the read<td>No<td>nil (block on read)</table>
33
+ <p>plugin.txt Ruby Example:</p>
34
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> udp_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8082</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
35
+ <p>plugin.txt Python Example:</p>
36
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">udp_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8082</span><span class="token plain"> None </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
37
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=http-client-interface>HTTP Client Interface<a href=#http-client-interface class=hash-link aria-label="Direct link to HTTP Client Interface" title="Direct link to HTTP Client Interface">​</a></h3>
38
+ <p>The HTTP client interface connects to a HTTP server to send commands and receive telemetry. This interface is commonly used with the <a href=/tools/staticdocs/docs/configuration/accessors#http-accessor>HttpAccessor</a> and <a href=/tools/staticdocs/docs/configuration/accessors#json-accessor>JsonAccessor</a>. See the <a href=https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-http-example target=_blank rel="noopener noreferrer">openc3-cosmos-http-example</a> for more information.</p>
39
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Host<td>Machine name to connect to<td>Yes<td><tr><td>Port<td>Port to write commands to and read telemetry from<td>No<td>80<tr><td>Protocol<td>HTTP or HTTPS protocol<td>No<td>HTTP<tr><td>Write Timeout<td>Number of seconds to wait before aborting the write. Pass nil / None to block on write.<td>No<td>5<tr><td>Read Timeout<td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.<td>No<td>nil / None<tr><td>Connect Timeout<td>Number of seconds to wait before aborting the connection<td>No<td>5<tr><td>Include Request In Response<td>Whether to include the request in the extra data<td>No<td>false</table>
40
+ <p>plugin.txt Ruby Examples:</p>
41
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> http_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb myserver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">com </span><span class="token number" style="color:rgb(247, 140, 108)">80</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
42
+ <p>plugin.txt Python Examples:</p>
43
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">http_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py mysecure</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">com </span><span class="token number" style="color:rgb(247, 140, 108)">443</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HTTPS</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
44
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=http-server-interface>HTTP Server Interface<a href=#http-server-interface class=hash-link aria-label="Direct link to HTTP Server Interface" title="Direct link to HTTP Server Interface">​</a></h3>
45
+ <p>The HTTP server interface creates a simple unencrypted, unauthenticated HTTP server. This interface is commonly used with the <a href=/tools/staticdocs/docs/configuration/accessors#http-accessor>HttpAccessor</a> and <a href=/tools/staticdocs/docs/configuration/accessors#json-accessor>JsonAccessor</a>. See the <a href=https://github.com/OpenC3/cosmos/tree/main/examples/openc3-cosmos-http-example target=_blank rel="noopener noreferrer">openc3-cosmos-http-example</a> for more information.</p>
46
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Port<td>Port to write commands to and read telemetry from<td>No<td>80</table>
47
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-1>Interface Options<a href=#interface-options-1 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
48
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
49
+ <table><thead><tr><th>Option<th>Description<th>Default<tbody><tr><td>LISTEN_ADDRESS<td>IP address to accept connections on<td>0.0.0.0</table>
50
+ <p>plugin.txt Ruby Examples:</p>
51
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> http_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LISTEN_ADDRESS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">127.0</span><span class="token number" style="color:rgb(247, 140, 108)">.0</span><span class="token number" style="color:rgb(247, 140, 108)">.1</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
52
+ <p>plugin.txt Python Examples:</p>
53
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">http_server_interface</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)">88</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
54
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=mqtt-interface>MQTT Interface<a href=#mqtt-interface class=hash-link aria-label="Direct link to MQTT Interface" title="Direct link to MQTT Interface">​</a></h3>
55
+ <p>The MQTT interface is typically used for connecting to Internet of Things (IoT) devices. The COSMOS MQTT interface is a client that can both publish and receive messages (commands and telemetry). It has built in support for SSL certificates as well as authentication. It differs from the MQTT Streaming Interface in that the commands and telemetry are transmitted over topics given by <code>META TOPIC</code> in the command and telemetry definitions.</p>
56
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Host<td>Host name or IP address of the MQTT broker<td>Yes<td><tr><td>Port<td>Port on the MQTT broker to connect to. Keep in mind whether you're using SSL or not.<td>No<td>1883<tr><td>SSL<td>Whether to use SSL to connect<td>No<td>false</table>
57
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-2>Interface Options<a href=#interface-options-2 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
58
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
59
+ <table><thead><tr><th>Option<th>Description<tbody><tr><td>ACK_TIMEOUT<td>Time to wait when connecting to the MQTT broker<tr><td>USERNAME<td>Username for authentication with the MQTT broker<tr><td>PASSWORD<td>Password for authentication with the MQTT broker<tr><td>CERT<td>PEM encoded client certificate filename used with KEY for client TLS based authentication<tr><td>KEY<td>PEM encoded client private keys filename<tr><td>KEYFILE_PASSWORD<td>Password to decrypt the CERT and KEY files (Python only)<tr><td>CA_FILE<td>Certificate Authority certificate filename that is to be treated as trusted by this client</table>
60
+ <p>plugin.txt Ruby Example:</p>
61
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_INT</span><span class="token plain"> mqtt_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb test</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">mosquitto</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">org </span><span class="token number" style="color:rgb(247, 140, 108)">1883</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
62
+ <p>plugin.txt Python Example (Note: This example uses the <a href=/tools/staticdocs/docs/configuration/plugins#secret>SECRET</a> keyword to set the PASSWORD option in the Interface):</p>
63
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_INT</span><span class="token plain"> 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">mqtt_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py test</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">mosquitto</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">org </span><span class="token number" style="color:rgb(247, 140, 108)">8884</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</span><span class="token plain"> rw</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"># Create an env variable called MQTT_PASSWORD with the secret named PASSWORD</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 set an OPTION called PASSWORD with the secret value</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"># For more information about secrets see the Admin Tool page</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PASSWORD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_PASSWORD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PASSWORD</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
64
+ <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>
65
+ <p>The MQTT Interface utilizes 'META TOPIC &lt;topic name>' in the command and telemetry definition files to determine which topics to publish and receive messages from. Thus to send to the topic 'TEST' you would create a command like the following (Note: The command name 'TEST' does NOT have to match the topic name):</p>
66
+ <div class="codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-text codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">COMMAND MQTT TEST BIG_ENDIAN "Test"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> META TOPIC TEST # &lt;- The topic name is 'TEST'</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> APPEND_PARAMETER DATA 0 BLOCK '' "MQTT Data"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
67
+ <p>Similarly to receive from the topic 'TEST' you would create a telemetry packet like the following (Note: The telemetry name 'TEST' does NOT have to match the topic name):</p>
68
+ <div class="codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-text codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">TELEMETRY MQTT TEST BIG_ENDIAN "Test"</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> META TOPIC TEST # &lt;- The topic name is 'TEST'</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> APPEND_ITEM DATA 0 BLOCK "MQTT Data"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
69
+ <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-mqtt-test target=_blank rel="noopener noreferrer">openc3-cosmos-mqtt-test</a> in the COSMOS source.</p>
70
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=mqtt-streaming-interface>MQTT Streaming Interface<a href=#mqtt-streaming-interface class=hash-link aria-label="Direct link to MQTT Streaming Interface" title="Direct link to MQTT Streaming Interface">​</a></h3>
71
+ <p>The MQTT streaming interface is typically used for connecting to Internet of Things (IoT) devices. The COSMOS MQTT streaming interface is a client that can both publish and receive messages (commands and telemetry). It has built in support for SSL certificates as well as authentication. It differs from the MQTT Interface in that all the commands are transmitted on a single topic and all telemetry is received on a single topic.</p>
72
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Host<td>Host name or IP address of the MQTT broker<td>Yes<td><tr><td>Port<td>Port on the MQTT broker to connect to. Keep in mind whether you're using SSL or not.<td>No<td>1883<tr><td>SSL<td>Whether to use SSL to connect<td>No<td>false<tr><td>Write Topic<td>Name of the write topic for all commands. Pass nil / None to make interface read only.<td>No<td>nil / None<tr><td>Read Topic<td>Name of the read topic for all telemetry. Pass nil / None to make interface write only.<td>No<td>nil / None<tr><td>Protocol Type<td>See Protocols.<td>No<td><tr><td>Protocol Arguments<td>See Protocols for the arguments each stream protocol takes.<td>No<td></table>
73
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-3>Interface Options<a href=#interface-options-3 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
74
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
75
+ <table><thead><tr><th>Option<th>Description<tbody><tr><td>ACK_TIMEOUT<td>Time to wait when connecting to the MQTT broker<tr><td>USERNAME<td>Username for authentication with the MQTT broker<tr><td>PASSWORD<td>Password for authentication with the MQTT broker<tr><td>CERT<td>PEM encoded client certificate filename used with KEY for client TLS based authentication<tr><td>KEY<td>PEM encoded client private keys filename<tr><td>KEYFILE_PASSWORD<td>Password to decrypt the CERT and KEY files (Python only)<tr><td>CA_FILE<td>Certificate Authority certificate filename that is to be treated as trusted by this client</table>
76
+ <p>plugin.txt Ruby Example:</p>
77
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_INT</span><span class="token plain"> mqtt_stream_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb test</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">mosquitto</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">org </span><span class="token number" style="color:rgb(247, 140, 108)">1883</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token plain"> write read</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
78
+ <p>plugin.txt Python Example (Note: This example uses the <a href=/tools/staticdocs/docs/configuration/plugins#secret>SECRET</a> keyword to set the PASSWORD option in the Interface):</p>
79
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_INT</span><span class="token plain"> 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">mqtt_stream_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py test</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">mosquitto</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">org </span><span class="token number" style="color:rgb(247, 140, 108)">8884</span><span class="token plain"> False write read</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</span><span class="token plain"> rw</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"># Create an env variable called MQTT_PASSWORD with the secret named PASSWORD</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 set an OPTION called PASSWORD with the secret value</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"># For more information about secrets see the Admin Tool page</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SECRET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PASSWORD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MQTT_PASSWORD</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PASSWORD</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
80
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=packet-definitions-1>Packet Definitions<a href=#packet-definitions-1 class=hash-link aria-label="Direct link to Packet Definitions" title="Direct link to Packet Definitions">​</a></h4>
81
+ <p>The MQTT Streaming Interface utilizes the topic names passed to the interface so no additional information is necessary in the definition.</p>
82
+ <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-mqtt-test target=_blank rel="noopener noreferrer">openc3-cosmos-mqtt-test</a> in the COSMOS source.</p>
83
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=serial-interface>Serial Interface<a href=#serial-interface class=hash-link aria-label="Direct link to Serial Interface" title="Direct link to Serial Interface">​</a></h3>
84
+ <p>The serial interface connects to a target over a serial port. COSMOS provides drivers for both Windows and POSIX drivers for UNIX based systems. The Serial Interface is currently only implemented in Ruby.</p>
85
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Write Port<td>Name of the serial port to write, e.g. 'COM1' or '/dev/ttyS0'. Pass nil / None to disable writing.<td>Yes<tr><td>Read Port<td>Name of the serial port to read, e.g. 'COM1' or '/dev/ttyS0'. Pass nil / None to disable reading.<td>Yes<tr><td>Baud Rate<td>Baud rate to read and write<td>Yes<tr><td>Parity<td>Serial port parity. Must be 'NONE', 'EVEN', or 'ODD'.<td>Yes<tr><td>Stop Bits<td>Number of stop bits, e.g. 1.<td>Yes<tr><td>Write Timeout<td>Number of seconds to wait before aborting the write<td>Yes<tr><td>Read Timeout<td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.<td>Yes<tr><td>Protocol Type<td>See Protocols.<td>No<tr><td>Protocol Arguments<td>See Protocols for the arguments each stream protocol takes.<td>No</table>
86
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-4>Interface Options<a href=#interface-options-4 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
87
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
88
+ <table><thead><tr><th>Option<th>Description<th>Default<tbody><tr><td>FLOW_CONTROL<td>Serial port flow control. Must be one of NONE or RTSCTS.<td>NONE<tr><td>DATA_BITS<td>Number of data bits.<td>8</table>
89
+ <p>plugin.txt Ruby Examples:</p>
90
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">9600</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token number" style="color:rgb(247, 140, 108)">38400</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ODD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">19200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EVEN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token number" style="color:rgb(247, 140, 108)">57600</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOW_CONTROL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">RTSCTS</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA_BITS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
91
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=snmp-interface-enterprise>SNMP Interface (Enterprise)<a href=#snmp-interface-enterprise class=hash-link aria-label="Direct link to SNMP Interface (Enterprise)" title="Direct link to SNMP Interface (Enterprise)">​</a></h3>
92
+ <p>The SNMP Interface is for connecting to Simple Network Management Protocol devices. The SNMP Interface is currently only implemented in Ruby.</p>
93
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Host<td>Host name of the SNMP device<td>Yes<td><tr><td>Port<td>Port on the SNMP device<td>No<td>161</table>
94
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-5>Interface Options<a href=#interface-options-5 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
95
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
96
+ <table><thead><tr><th>Option<th>Description<th>Default<tbody><tr><td>VERSION<td>SNMP Version: 1, 2, or 3<td>1<tr><td>COMMUNITY<td>Password or user ID that allows access to a device<td>private<tr><td>USERNAME<td>Username<td>N/A<tr><td>RETRIES<td>Retries when sending requests<td>N/A<tr><td>TIMEOUT<td>Timeout waiting for a response from an agent<td>N/A<tr><td>CONTEXT<td>SNMP context<td>N/A<tr><td>SECURITY_LEVEL<td>Must be one of NO_AUTH, AUTH_PRIV, or AUTH_NO_PRIV<td>N/A<tr><td>AUTH_PROTOCOL<td>Must be one of MD5, SHA, or SHA256<td>N/A<tr><td>PRIV_PROTOCOL<td>Must be one of DES or AES<td>N/A<tr><td>AUTH_PASSWORD<td>Auth password<td>N/A<tr><td>PRIV_PASSWORD<td>Priv password<td>N/A</table>
97
+ <p>plugin.txt Ruby Examples:</p>
98
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SNMP_INT</span><span class="token plain"> snmp_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">192.168</span><span class="token number" style="color:rgb(247, 140, 108)">.1</span><span class="token number" style="color:rgb(247, 140, 108)">.249</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">161</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
99
+ <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-apc-switched-pdu target=_blank rel="noopener noreferrer">openc3-cosmos-apc-switched-pdu</a> in the COSMOS Enterprise Plugins.</p>
100
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=snmp-trap-interface-enterprise>SNMP Trap Interface (Enterprise)<a href=#snmp-trap-interface-enterprise class=hash-link aria-label="Direct link to SNMP Trap Interface (Enterprise)" title="Direct link to SNMP Trap Interface (Enterprise)">​</a></h3>
101
+ <p>The SNMP Trap Interface is for receiving Simple Network Management Protocol traps. The SNMP Trap Interface is currently only implemented in Ruby.</p>
102
+ <table><thead><tr><th>Parameter<th>Description<th>Required<th>Default<tbody><tr><td>Read Port<td>Port to read from<td>No<td>162<tr><td>Read Timeout<td>Read timeout<td>No<td>nil<tr><td>Bind Address<td>Address to bind UDP port to<td>Yes<td>0.0.0.0</table>
103
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-options-6>Interface Options<a href=#interface-options-6 class=hash-link aria-label="Direct link to Interface Options" title="Direct link to Interface Options">​</a></h4>
104
+ <p>Options are added directly beneath the interface definition as shown in the example.</p>
105
+ <table><thead><tr><th>Option<th>Description<th>Default<tbody><tr><td>VERSION<td>SNMP Version: 1, 2, or 3<td>1</table>
106
+ <p>plugin.txt Ruby Examples:</p>
107
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SNMP_INT</span><span class="token plain"> snmp_trap_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">162</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">OPTION</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">VERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
108
+ <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-apc-switched-pdu target=_blank rel="noopener noreferrer">openc3-cosmos-apc-switched-pdu</a> in the COSMOS Enterprise Plugins.</p>
109
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=grpc-interface-enterprise>gRPC Interface (Enterprise)<a href=#grpc-interface-enterprise class=hash-link aria-label="Direct link to gRPC Interface (Enterprise)" title="Direct link to gRPC Interface (Enterprise)">​</a></h3>
110
+ <p>The gRPC Interface is for interacting with <a href=https://grpc.io/ target=_blank rel="noopener noreferrer">gRPC</a>. The gRPC Interface is currently only implemented in Ruby.</p>
111
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Hostname<td>gRPC server<td>Yes<tr><td>Port<td>gRPC port<td>Yes</table>
112
+ <p>plugin.txt Ruby Examples:</p>
113
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GRPC_INT</span><span class="token plain"> grpc_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb my</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">grpc</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">org </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
114
+ <h4 class="anchor anchorWithStickyNavbar_fF9Z" id=commands>Commands<a href=#commands class=hash-link aria-label="Direct link to Commands" title="Direct link to Commands">​</a></h4>
115
+ <p>Using the GrpcInterface for <a href=/tools/staticdocs/docs/configuration/command>command definitions</a> requires the use of <a href=/tools/staticdocs/docs/configuration/command#meta>META</a> to define a GRPC_METHOD to use for each command.</p>
116
+ <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">COMMAND</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTO</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GET_USER</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)">'Get a User'</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)">META</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GRPC_METHOD</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">example</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">photoservice</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">ExamplePhotoService</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">GetUser</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
117
+ <p>For a full example, please see the <a href=https://github.com/OpenC3/cosmos-enterprise-plugins/tree/main/openc3-cosmos-proto-target target=_blank rel="noopener noreferrer">openc3-cosmos-proto-target</a> in the COSMOS Enterprise Plugins.</p>
118
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=custom-interfaces>Custom Interfaces<a href=#custom-interfaces class=hash-link aria-label="Direct link to Custom Interfaces" title="Direct link to Custom Interfaces">​</a></h2>
14
119
  <p>Interfaces have the following methods that must be implemented:</p>
15
120
  <ol>
16
121
  <li><strong>connect</strong> - Open the socket or port or somehow establish the connection to the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation.</li>
@@ -27,54 +132,4 @@
27
132
  <li><strong>write</strong> - Send a packet to the interface. COSMOS implements this method to allow the Protocol system to operate on the packet and the data before it is sent.</li>
28
133
  <li><strong>write_raw</strong> - Send a raw binary string of data to the target. COSMOS implements this method by basically calling write_interface with the raw data.</li>
29
134
  </ol>
30
- <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Naming Conventions</div><div class="admonitionContent_bl22"><p>When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described below. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive &quot;class not found&quot; errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.</p></div></div>
31
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="provided-interfaces">Provided Interfaces<a href="#provided-interfaces" class="hash-link" aria-label="Direct link to Provided Interfaces" title="Direct link to Provided Interfaces">​</a></h2>
32
- <p>COSMOS provides the following interfaces for use: TCPIP Client, TCPIP Server, UDP, and Serial. The interface to use is defined by the <a href="/tools/staticdocs/docs/configuration/plugins#interface">INTERFACE</a> and <a href="/tools/staticdocs/docs/configuration/plugins#router">ROUTER</a> keywords.</p>
33
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tcpip-client-interface">TCPIP Client Interface<a href="#tcpip-client-interface" class="hash-link" aria-label="Direct link to TCPIP Client Interface" title="Direct link to TCPIP Client Interface">​</a></h3>
34
- <p>The TCPIP client interface connects to a TCPIP socket to send commands and receive telemetry. This interface is used for targets which open a socket and wait for a connection. This is the most common type of interface.</p>
35
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Host</td><td>Machine name to connect to</td><td>Yes</td></tr><tr><td>Write Port</td><td>Port to write commands to (can be the same as read port). Pass nil / None to make the interface read only.</td><td>Yes</td></tr><tr><td>Read Port</td><td>Port to read telemetry from (can be the same as write port). Pass nil / None to make the interface write only.</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table>
36
- <p>plugin.txt Ruby Examples:</p>
37
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
38
- <p>plugin.txt Python Examples:</p>
39
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> None </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
40
- <p>See <a href="/tools/staticdocs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/staticdocs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword.</p>
41
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tcpip-server-interface">TCPIP Server Interface<a href="#tcpip-server-interface" class="hash-link" aria-label="Direct link to TCPIP Server Interface" title="Direct link to TCPIP Server Interface">​</a></h3>
42
- <p>The TCPIP server interface creates a TCPIP server which listens for incoming connections and dynamically creates sockets which communicate with the target. This interface is used for targets which open a socket and try to connect to a server.</p>
43
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Write Port</td><td>Port to write commands to (can be the same as read port)</td><td>Yes</td></tr><tr><td>Read Port</td><td>Port to read telemetry from (can be the same as write port)</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table>
44
- <p>plugin.txt Ruby Examples:</p>
45
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_server_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
46
- <p>plugin.txt Python Examples:</p>
47
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> None </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_server_interface</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)">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"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</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)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
48
- <p>See <a href="/tools/staticdocs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/staticdocs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword. Note, TcpipServerInterface processes the <a href="/tools/staticdocs/docs/configuration/plugins#option">OPTION</a> modifier.</p>
49
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="udp-interface">UDP Interface<a href="#udp-interface" class="hash-link" aria-label="Direct link to UDP Interface" title="Direct link to UDP Interface">​</a></h3>
50
- <p>The UDP interface uses UDP packets to send and receive telemetry from the target.</p>
51
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th><th>Default</th></tr></thead><tbody><tr><td>Host</td><td>Host name or IP address of the machine to send and receive data with</td><td>Yes</td><td></td></tr><tr><td>Write Dest Port</td><td>Port on the remote machine to send commands to</td><td>Yes</td><td></td></tr><tr><td>Read Port</td><td>Port on the remote machine to read telemetry from</td><td>Yes</td><td></td></tr><tr><td>Write Source Port</td><td>Port on the local machine to send commands from</td><td>No</td><td>nil (socket is not bound to an outgoing port)</td></tr><tr><td>Interface Address</td><td>If the remote machine supports multicast the interface address is used to configure the outgoing multicast address</td><td>No</td><td>nil (not used)</td></tr><tr><td>TTL</td><td>Time to Live. The number of intermediate routers allowed before dropping the packet.</td><td>No</td><td>128 (Windows)</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>No</td><td>10.0</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read</td><td>No</td><td>nil (block on read)</td></tr></tbody></table>
52
- <p>plugin.txt Ruby Example:</p>
53
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> udp_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8082</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
54
- <p>plugin.txt Python Example:</p>
55
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">udp_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8082</span><span class="token plain"> None </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
56
- <p>See <a href="/tools/staticdocs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/staticdocs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword.</p>
57
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="serial-interface">Serial Interface<a href="#serial-interface" class="hash-link" aria-label="Direct link to Serial Interface" title="Direct link to Serial Interface">​</a></h3>
58
- <p>The serial interface connects to a target over a serial port. COSMOS provides drivers for both Windows and POSIX drivers for UNIX based systems. The Serial Interface is currently only implemented in Ruby.</p>
59
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Write Port</td><td>Name of the serial port to write, e.g. &#x27;COM1&#x27; or &#x27;/dev/ttyS0&#x27;. Pass nil / None to disable writing.</td><td>Yes</td></tr><tr><td>Read Port</td><td>Name of the serial port to read, e.g. &#x27;COM1&#x27; or &#x27;/dev/ttyS0&#x27;. Pass nil / None to disable reading.</td><td>Yes</td></tr><tr><td>Baud Rate</td><td>Baud rate to read and write</td><td>Yes</td></tr><tr><td>Parity</td><td>Serial port parity. Must be &#x27;NONE&#x27;, &#x27;EVEN&#x27;, or &#x27;ODD&#x27;.</td><td>Yes</td></tr><tr><td>Stop Bits</td><td>Number of stop bits, e.g. 1.</td><td>Yes</td></tr><tr><td>Write Timeout</td><td>Number of seconds to wait before aborting the write</td><td>Yes</td></tr><tr><td>Read Timeout</td><td>Number of seconds to wait before aborting the read. Pass nil / None to block on read.</td><td>Yes</td></tr><tr><td>Protocol Type</td><td>See Protocols.</td><td>No</td></tr><tr><td>Protocol Arguments</td><td>See Protocols for the arguments each stream protocol takes.</td><td>No</td></tr></tbody></table>
60
- <p>plugin.txt Ruby Examples:</p>
61
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">9600</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xBA5EBA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS1 </span><span class="token number" style="color:rgb(247, 140, 108)">38400</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ODD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM2</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM2</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">19200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EVEN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">dev</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ttyS0 </span><span class="token number" style="color:rgb(247, 140, 108)">57600</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> serial_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COM4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">115200</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">NONE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># no built-in protocol</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
62
- <p>See <a href="/tools/staticdocs/docs/configuration/plugins#interface">INTERFACE</a> for a description of the INTERFACE keyword. See <a href="/tools/staticdocs/docs/configuration/plugins#interface-modifiers">Interface Modifiers</a> for a description of the keywords which can follow the INTERFACE keyword. Note, SerialInterface processes the <a href="/tools/staticdocs/docs/configuration/plugins#option">OPTION</a> modifier.</p>
63
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="streams">Streams<a href="#streams" class="hash-link" aria-label="Direct link to Streams" title="Direct link to Streams">​</a></h2>
64
- <p>Streams are low level classes that implement read, read_nonblock, write, connect, connected? and disconnect methods. The built-in Stream classes are SerialStream, TcpipSocketStream and TcpipClientStream and they are automatically used when creating a Serial Interface, TCP/IP Server Interface, or TCP/IP Client Interface.</p>
65
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="protocols">Protocols<a href="#protocols" class="hash-link" aria-label="Direct link to Protocols" title="Direct link to Protocols">​</a></h2>
66
- <p>Protocols define the behaviour of an Interface, including differentiating packet boundaries and modifying data as necessary. COSMOS defines the following built-in protocols which can be used with the above interfaces:</p>
67
- <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#burst-protocol">Burst</a></td><td>Reads as much data as possible from the interface</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#fixed-protocol">Fixed</a></td><td>Processes fixed length packets with a known ID position</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#length-protocol">Length</a></td><td>Processes a length field at a fixed location and then reads the remainder of the data</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#terminated-protocol">Terminated</a></td><td>Delineates packets uses termination characters at the end of each packet</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#template-protocol">Template</a></td><td>Processes text based command / response data such as SCPI interfaces</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#preidentified-protocol">Preidentified</a></td><td>Internal COSMOS protocol used by COSMOS tools</td></tr></tbody></table>
68
- <p>These protocols are declared directly after the interface:</p>
69
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
70
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">FIXED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> None </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">LENGTH</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TERMINATED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0D0A</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xF005BA11</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMPLATE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xA</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">PREIDENTIFIED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xCAFEBABE</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
71
- <p>COSMOS also defines the following helper protocols:</p>
72
- <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#crc-protocol">CRC</a></td><td>Adds CRCs to outgoing packets and verifies CRCs on incoming packets</td></tr><tr><td><a href="/tools/staticdocs/docs/configuration/protocols#ignore-packet-protocol">Ignore</a></td><td>Ignores the specified packet by dropping it</td></tr></tbody></table>
73
- <p>These protocols are declared after the INTERFACE:</p>
74
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TGT</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WRITE</span><span class="token plain"> CrcProtocol </span><span class="token constant" style="color:rgb(130, 170, 255)">CRC</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># See the documentation for parameters</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
75
- <div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INTERFACE_NAME</span><span class="token plain"> 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">tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> None </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TGT</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">WRITE</span><span class="token plain"> CrcProtocol </span><span class="token constant" style="color:rgb(130, 170, 255)">CRC</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># See the documentation for parameters</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
76
- <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>
77
- <p>In addition, you can define your own protocols which are declared like the COSMOS helper protocols after your interface. See the <a href="/tools/staticdocs/docs/configuration/protocols#custom-protocols">Custom Protocols</a> documentation for more information.</p>
78
- <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Protocol Run Order</div><div class="admonitionContent_bl22"><p>Read protocols execute in the order specified (First specified runs first). Write protocols execute in the reverse order (Last specified executes first).</p></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="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/interfaces.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/telemetry"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Telemetry</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/protocols"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Protocols</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#provided-interfaces" class="table-of-contents__link toc-highlight">Provided Interfaces</a><ul><li><a href="#tcpip-client-interface" class="table-of-contents__link toc-highlight">TCPIP Client Interface</a></li><li><a href="#tcpip-server-interface" class="table-of-contents__link toc-highlight">TCPIP Server Interface</a></li><li><a href="#udp-interface" class="table-of-contents__link toc-highlight">UDP Interface</a></li><li><a href="#serial-interface" class="table-of-contents__link toc-highlight">Serial Interface</a></li></ul></li><li><a href="#streams" class="table-of-contents__link toc-highlight">Streams</a></li><li><a href="#protocols" class="table-of-contents__link toc-highlight">Protocols</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
79
- </body>
80
- </html>
135
+ <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>Naming Conventions</div><div class=admonitionContent_bl22><p>When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described below. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive "class not found" errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.</div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/interfaces.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="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/telemetry><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Telemetry</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/protocols><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Protocols</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#overview class="table-of-contents__link toc-highlight">Overview</a><ul><li><a href=#protocols class="table-of-contents__link toc-highlight">Protocols</a><li><a href=#accessors class="table-of-contents__link toc-highlight">Accessors</a></ul><li><a href=#provided-interfaces class="table-of-contents__link toc-highlight">Provided Interfaces</a><ul><li><a href=#tcpip-client-interface class="table-of-contents__link toc-highlight">TCPIP Client Interface</a><li><a href=#tcpip-server-interface class="table-of-contents__link toc-highlight">TCPIP Server Interface</a><ul><li><a href=#interface-options class="table-of-contents__link toc-highlight">Interface Options</a></ul><li><a href=#udp-interface class="table-of-contents__link toc-highlight">UDP Interface</a><li><a href=#http-client-interface class="table-of-contents__link toc-highlight">HTTP Client Interface</a><li><a href=#http-server-interface class="table-of-contents__link toc-highlight">HTTP Server Interface</a><ul><li><a href=#interface-options-1 class="table-of-contents__link toc-highlight">Interface Options</a></ul><li><a href=#mqtt-interface class="table-of-contents__link toc-highlight">MQTT Interface</a><ul><li><a href=#interface-options-2 class="table-of-contents__link toc-highlight">Interface Options</a><li><a href=#packet-definitions class="table-of-contents__link toc-highlight">Packet Definitions</a></ul><li><a href=#mqtt-streaming-interface class="table-of-contents__link toc-highlight">MQTT Streaming Interface</a><ul><li><a href=#interface-options-3 class="table-of-contents__link toc-highlight">Interface Options</a><li><a href=#packet-definitions-1 class="table-of-contents__link toc-highlight">Packet Definitions</a></ul><li><a href=#serial-interface class="table-of-contents__link toc-highlight">Serial Interface</a><ul><li><a href=#interface-options-4 class="table-of-contents__link toc-highlight">Interface Options</a></ul><li><a href=#snmp-interface-enterprise class="table-of-contents__link toc-highlight">SNMP Interface (Enterprise)</a><ul><li><a href=#interface-options-5 class="table-of-contents__link toc-highlight">Interface Options</a></ul><li><a href=#snmp-trap-interface-enterprise class="table-of-contents__link toc-highlight">SNMP Trap Interface (Enterprise)</a><ul><li><a href=#interface-options-6 class="table-of-contents__link toc-highlight">Interface Options</a></ul><li><a href=#grpc-interface-enterprise class="table-of-contents__link toc-highlight">gRPC Interface (Enterprise)</a><ul><li><a href=#commands class="table-of-contents__link toc-highlight">Commands</a></ul></ul><li><a href=#custom-interfaces class="table-of-contents__link toc-highlight">Custom Interfaces</a></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></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 © 2024 OpenC3, Inc.</div></div></div></footer></div>