openc3-cosmos-tool-docs 5.20.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (427) 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/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png +0 -0
  66. data/tools/staticdocs/assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png +0 -0
  67. data/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png +0 -0
  68. data/tools/staticdocs/assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png +0 -0
  69. data/tools/staticdocs/assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png +0 -0
  70. data/tools/staticdocs/assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png +0 -0
  71. data/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png +0 -0
  72. data/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png +0 -0
  73. data/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png +0 -0
  74. data/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png +0 -0
  75. data/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png +0 -0
  76. data/tools/staticdocs/assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png +0 -0
  77. data/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png +0 -0
  78. data/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png +0 -0
  79. data/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png +0 -0
  80. data/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png +0 -0
  81. data/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png +0 -0
  82. data/tools/staticdocs/assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png +0 -0
  83. data/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png +0 -0
  84. data/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png +0 -0
  85. data/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png +0 -0
  86. data/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png +0 -0
  87. data/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png +0 -0
  88. data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
  89. data/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png +0 -0
  90. data/tools/staticdocs/assets/js/019369f3.8413befc.js +1 -0
  91. data/tools/staticdocs/assets/js/058ffc22.a4ceeb8e.js +1 -0
  92. data/tools/staticdocs/assets/js/0686a885.ae0a89e8.js +1 -0
  93. data/tools/staticdocs/assets/js/078dbab0.90ef4019.js +1 -0
  94. data/tools/staticdocs/assets/js/0f5d161c.1c827de2.js +1 -0
  95. data/tools/staticdocs/assets/js/0ff569c9.3b7f9c95.js +1 -0
  96. data/tools/staticdocs/assets/js/103cc3be.76716a45.js +1 -0
  97. data/tools/staticdocs/assets/js/13196248.18801ae0.js +1 -0
  98. data/tools/staticdocs/assets/js/13c1b4e4.4457fa9a.js +1 -0
  99. data/tools/staticdocs/assets/js/1602.1e622848.js +1 -0
  100. data/tools/staticdocs/assets/js/1e02e6a3.8e63f255.js +1 -0
  101. data/tools/staticdocs/assets/js/2047b354.9470f5c9.js +1 -0
  102. data/tools/staticdocs/assets/js/2124.0e1f26f5.js +1 -0
  103. data/tools/staticdocs/assets/js/22b3ac48.ac895789.js +1 -0
  104. data/tools/staticdocs/assets/js/26b8abb2.45d268b1.js +1 -0
  105. data/tools/staticdocs/assets/js/2bb7bf90.471e10a1.js +1 -0
  106. data/tools/staticdocs/assets/js/3040.18a0bb2a.js +4 -0
  107. data/tools/staticdocs/assets/js/3687.6fa52db1.js +101 -0
  108. data/tools/staticdocs/assets/js/3dd7ef3b.d8bb37a8.js +1 -0
  109. data/tools/staticdocs/assets/js/40365d27.5f8a5da7.js +1 -0
  110. data/tools/staticdocs/assets/js/411898ad.c8f67fde.js +1 -0
  111. data/tools/staticdocs/assets/js/42170351.86617d4a.js +1 -0
  112. data/tools/staticdocs/assets/js/4303.a84f454a.js +1 -0
  113. data/tools/staticdocs/assets/js/43652efd.0c473c25.js +1 -0
  114. data/tools/staticdocs/assets/js/53ca7c5b.f0e35da3.js +1 -0
  115. data/tools/staticdocs/assets/js/54d0d530.9ace531c.js +1 -0
  116. data/tools/staticdocs/assets/js/5b233ba7.565c0c28.js +1 -0
  117. data/tools/staticdocs/assets/js/5bc719f6.80b7b43c.js +1 -0
  118. data/tools/staticdocs/assets/js/5c6ce5ec.ed839e0d.js +1 -0
  119. data/tools/staticdocs/assets/js/5e3ed378.048e258b.js +1 -0
  120. data/tools/staticdocs/assets/js/5fe211ef.96109971.js +1 -0
  121. data/tools/staticdocs/assets/js/62df909c.dd5f3a0c.js +1 -0
  122. data/tools/staticdocs/assets/js/630e5448.699a9dec.js +1 -0
  123. data/tools/staticdocs/assets/js/6831b732.4008a669.js +1 -0
  124. data/tools/staticdocs/assets/js/696b4199.34aa1d77.js +1 -0
  125. data/tools/staticdocs/assets/js/6b210247.d37e3087.js +1 -0
  126. data/tools/staticdocs/assets/js/6b65133b.f71c0e94.js +1 -0
  127. data/tools/staticdocs/assets/js/6f92e431.c98e31e0.js +1 -0
  128. data/tools/staticdocs/assets/js/72c6d8a8.1053fbd7.js +1 -0
  129. data/tools/staticdocs/assets/js/75897369.522ccdd7.js +1 -0
  130. data/tools/staticdocs/assets/js/75e64983.6b588c87.js +1 -0
  131. data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
  132. data/tools/staticdocs/assets/js/7f5b2696.72e3b019.js +1 -0
  133. data/tools/staticdocs/assets/js/80c97f38.5a408d9c.js +1 -0
  134. data/tools/staticdocs/assets/js/867640d5.866fe67b.js +1 -0
  135. data/tools/staticdocs/assets/js/89e76475.b4e9da15.js +1 -0
  136. data/tools/staticdocs/assets/js/8f7843ee.59da8025.js +1 -0
  137. data/tools/staticdocs/assets/js/9424f0b3.cc8aa06e.js +1 -0
  138. data/tools/staticdocs/assets/js/97535711.94a5b402.js +1 -0
  139. data/tools/staticdocs/assets/js/99581c43.ebea1d08.js +1 -0
  140. data/tools/staticdocs/assets/js/9d6e81d0.4bc52207.js +1 -0
  141. data/tools/staticdocs/assets/js/{9fb6059a.a5107afb.js → 9fb6059a.57936fbe.js} +1 -1
  142. data/tools/staticdocs/assets/js/a677c089.d8d7a8f5.js +1 -0
  143. data/tools/staticdocs/assets/js/a9987364.2aa836fd.js +1 -0
  144. data/tools/staticdocs/assets/js/aa6b6c1b.4f484861.js +1 -0
  145. data/tools/staticdocs/assets/js/b4596165.a5fe2cea.js +1 -0
  146. data/tools/staticdocs/assets/js/b6d70f94.5df56282.js +1 -0
  147. data/tools/staticdocs/assets/js/b9f60ba6.cdb4a698.js +1 -0
  148. data/tools/staticdocs/assets/js/bd0034eb.5fb449fc.js +1 -0
  149. data/tools/staticdocs/assets/js/c24eae19.f419c8fb.js +1 -0
  150. data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +1 -0
  151. data/tools/staticdocs/assets/js/c5388ca4.32f8f561.js +1 -0
  152. data/tools/staticdocs/assets/js/cb8c3f08.9264e5dd.js +1 -0
  153. data/tools/staticdocs/assets/js/cd879be4.aa3c877c.js +1 -0
  154. data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +1 -0
  155. data/tools/staticdocs/assets/js/d1b923aa.de9e8fd6.js +1 -0
  156. data/tools/staticdocs/assets/js/d1bfc316.82dd17ab.js +1 -0
  157. data/tools/staticdocs/assets/js/d24bf9b6.1cb515f4.js +1 -0
  158. data/tools/staticdocs/assets/js/d57a4b5d.09769a64.js +1 -0
  159. data/tools/staticdocs/assets/js/d5d77c37.1704d750.js +1 -0
  160. data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js +1 -0
  161. data/tools/staticdocs/assets/js/d8ca4191.1861d710.js +1 -0
  162. data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js +1 -0
  163. data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js +1 -0
  164. data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js +1 -0
  165. data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js +1 -0
  166. data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js +1 -0
  167. data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js +1 -0
  168. data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js +1 -0
  169. data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js +1 -0
  170. data/tools/staticdocs/assets/js/fd886806.fa25adc4.js +1 -0
  171. data/tools/staticdocs/assets/js/main.1a59b278.js +36 -0
  172. data/tools/staticdocs/assets/js/runtime~main.25e99a76.js +1 -0
  173. data/tools/staticdocs/docs/configuration/accessors.html +85 -0
  174. data/tools/staticdocs/docs/configuration/command.html +148 -160
  175. data/tools/staticdocs/docs/configuration/format.html +28 -40
  176. data/tools/staticdocs/docs/configuration/interfaces.html +119 -64
  177. data/tools/staticdocs/docs/configuration/plugins.html +234 -225
  178. data/tools/staticdocs/docs/configuration/protocols.html +106 -92
  179. data/tools/staticdocs/docs/configuration/ssl-tls.html +34 -46
  180. data/tools/staticdocs/docs/configuration/table.html +88 -100
  181. data/tools/staticdocs/docs/configuration/target.html +29 -41
  182. data/tools/staticdocs/docs/configuration/telemetry-screens.html +368 -322
  183. data/tools/staticdocs/docs/configuration/telemetry.html +136 -142
  184. data/tools/staticdocs/docs/configuration.html +1 -13
  185. data/tools/staticdocs/docs/development/curl.html +17 -29
  186. data/tools/staticdocs/docs/development/developing.html +24 -36
  187. data/tools/staticdocs/docs/development/json-api.html +26 -38
  188. data/tools/staticdocs/docs/development/log-structure.html +19 -31
  189. data/tools/staticdocs/docs/development/roadmap.html +26 -44
  190. data/tools/staticdocs/docs/development/streaming-api.html +10 -22
  191. data/tools/staticdocs/docs/development/testing.html +23 -27
  192. data/tools/staticdocs/docs/development.html +1 -13
  193. data/tools/staticdocs/docs/getting-started/generators.html +37 -49
  194. data/tools/staticdocs/docs/getting-started/gettingstarted.html +45 -56
  195. data/tools/staticdocs/docs/getting-started/installation.html +24 -36
  196. data/tools/staticdocs/docs/getting-started/key_concepts.html +32 -44
  197. data/tools/staticdocs/docs/getting-started/podman.html +25 -37
  198. data/tools/staticdocs/docs/getting-started/requirements.html +32 -44
  199. data/tools/staticdocs/docs/getting-started/upgrading.html +134 -24
  200. data/tools/staticdocs/docs/getting-started.html +1 -13
  201. data/tools/staticdocs/docs/guides/bridges.html +17 -30
  202. data/tools/staticdocs/docs/guides/cfs.html +46 -58
  203. data/tools/staticdocs/docs/guides/custom-widgets.html +17 -29
  204. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -15
  205. data/tools/staticdocs/docs/guides/local-mode.html +16 -28
  206. data/tools/staticdocs/docs/guides/logging.html +12 -24
  207. data/tools/staticdocs/docs/guides/monitoring.html +18 -30
  208. data/tools/staticdocs/docs/guides/performance.html +21 -33
  209. data/tools/staticdocs/docs/guides/raspberrypi.html +16 -28
  210. data/tools/staticdocs/docs/guides/script-writing.html +108 -120
  211. data/tools/staticdocs/docs/guides/scripting-api.html +606 -615
  212. data/tools/staticdocs/docs/guides.html +1 -13
  213. data/tools/staticdocs/docs/meta/contributing.html +14 -26
  214. data/tools/staticdocs/docs/meta/licenses.html +36 -25
  215. data/tools/staticdocs/docs/meta/philosophy.html +3 -15
  216. data/tools/staticdocs/docs/meta/xtce.html +13 -25
  217. data/tools/staticdocs/docs/meta.html +1 -13
  218. data/tools/staticdocs/docs/privacy.html +19 -31
  219. data/tools/staticdocs/docs/tools/admin.html +36 -0
  220. data/tools/staticdocs/docs/tools/autonomic.html +22 -34
  221. data/tools/staticdocs/docs/tools/bucket-explorer.html +10 -22
  222. data/tools/staticdocs/docs/tools/calendar.html +21 -33
  223. data/tools/staticdocs/docs/tools/cmd-sender.html +16 -28
  224. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +27 -36
  225. data/tools/staticdocs/docs/tools/command_history.html +10 -0
  226. data/tools/staticdocs/docs/tools/data-extractor.html +29 -41
  227. data/tools/staticdocs/docs/tools/data-viewer.html +11 -23
  228. data/tools/staticdocs/docs/tools/handbooks.html +4 -16
  229. data/tools/staticdocs/docs/tools/limits-monitor.html +18 -30
  230. data/tools/staticdocs/docs/tools/packet-viewer.html +16 -28
  231. data/tools/staticdocs/docs/tools/script-runner.html +43 -55
  232. data/tools/staticdocs/docs/tools/table-manager.html +16 -28
  233. data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -33
  234. data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -28
  235. data/tools/staticdocs/docs/tools.html +1 -13
  236. data/tools/staticdocs/docs.html +12 -24
  237. data/tools/staticdocs/img/admin/add_tool.png +0 -0
  238. data/tools/staticdocs/img/admin/interfaces.png +0 -0
  239. data/tools/staticdocs/img/admin/microservices.png +0 -0
  240. data/tools/staticdocs/img/admin/packages.png +0 -0
  241. data/tools/staticdocs/img/admin/plugins.png +0 -0
  242. data/tools/staticdocs/img/admin/redis.png +0 -0
  243. data/tools/staticdocs/img/admin/routers.png +0 -0
  244. data/tools/staticdocs/img/admin/secrets.png +0 -0
  245. data/tools/staticdocs/img/admin/settings1.png +0 -0
  246. data/tools/staticdocs/img/admin/settings2.png +0 -0
  247. data/tools/staticdocs/img/admin/targets.png +0 -0
  248. data/tools/staticdocs/img/admin/tools.png +0 -0
  249. data/tools/staticdocs/img/cmd_tlm_server/cmd_authority.png +0 -0
  250. data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
  251. data/tools/staticdocs/img/cmd_tlm_server/critical_cmd_sender.png +0 -0
  252. data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
  253. data/tools/staticdocs/img/command_history/command_history.png +0 -0
  254. data/tools/staticdocs/img/command_sender/collect_states.png +0 -0
  255. data/tools/staticdocs/img/command_sender/command_sender.png +0 -0
  256. data/tools/staticdocs/img/command_sender/history.png +0 -0
  257. data/tools/staticdocs/img/command_sender/inst_clear.png +0 -0
  258. data/tools/staticdocs/img/command_sender/inst_collect.png +0 -0
  259. data/tools/staticdocs/img/command_sender/inst_collect_hazardous.png +0 -0
  260. data/tools/staticdocs/img/command_sender/mode_menu.png +0 -0
  261. data/tools/staticdocs/img/telemetry_viewer/widgets/array.png +0 -0
  262. data/tools/staticdocs/img/telemetry_viewer/widgets/backcolor.png +0 -0
  263. data/tools/staticdocs/img/telemetry_viewer/widgets/block.png +0 -0
  264. data/tools/staticdocs/img/telemetry_viewer/widgets/bordercolor.png +0 -0
  265. data/tools/staticdocs/img/telemetry_viewer/widgets/button.png +0 -0
  266. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasdot.png +0 -0
  267. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimage.png +0 -0
  268. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimagevalue.png +0 -0
  269. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabel.png +0 -0
  270. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabelvalue.png +0 -0
  271. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasline.png +0 -0
  272. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslinevalue.png +0 -0
  273. data/tools/staticdocs/img/telemetry_viewer/widgets/checkbutton.png +0 -0
  274. data/tools/staticdocs/img/telemetry_viewer/widgets/combobox.png +0 -0
  275. data/tools/staticdocs/img/telemetry_viewer/widgets/date.png +0 -0
  276. data/tools/staticdocs/img/telemetry_viewer/widgets/formatvalue.png +0 -0
  277. data/tools/staticdocs/img/telemetry_viewer/widgets/height.png +0 -0
  278. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontal.png +0 -0
  279. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
  280. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalline.png +0 -0
  281. data/tools/staticdocs/img/telemetry_viewer/widgets/iframe.png +0 -0
  282. data/tools/staticdocs/img/telemetry_viewer/widgets/imageviewer.png +0 -0
  283. data/tools/staticdocs/img/telemetry_viewer/widgets/label.png +0 -0
  284. data/tools/staticdocs/img/telemetry_viewer/widgets/labelled.png +0 -0
  285. data/tools/staticdocs/img/telemetry_viewer/widgets/labelprogressbar.png +0 -0
  286. data/tools/staticdocs/img/telemetry_viewer/widgets/labelsparkline.png +0 -0
  287. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvalue.png +0 -0
  288. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluedesc.png +0 -0
  289. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluelimitscolumn.png +0 -0
  290. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluerangebar.png +0 -0
  291. data/tools/staticdocs/img/telemetry_viewer/widgets/led.png +0 -0
  292. data/tools/staticdocs/img/telemetry_viewer/widgets/limitsbar.png +0 -0
  293. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolor.png +0 -0
  294. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolumn.png +0 -0
  295. data/tools/staticdocs/img/telemetry_viewer/widgets/linegraph.png +0 -0
  296. data/tools/staticdocs/img/telemetry_viewer/widgets/margin.png +0 -0
  297. data/tools/staticdocs/img/telemetry_viewer/widgets/matrixbycolumns.png +0 -0
  298. data/tools/staticdocs/img/telemetry_viewer/widgets/named_widget.png +0 -0
  299. data/tools/staticdocs/img/telemetry_viewer/widgets/padding.png +0 -0
  300. data/tools/staticdocs/img/telemetry_viewer/widgets/progressbar.png +0 -0
  301. data/tools/staticdocs/img/telemetry_viewer/widgets/radiobutton.png +0 -0
  302. data/tools/staticdocs/img/telemetry_viewer/widgets/rangebar.png +0 -0
  303. data/tools/staticdocs/img/telemetry_viewer/widgets/raw.png +0 -0
  304. data/tools/staticdocs/img/telemetry_viewer/widgets/rollup.png +0 -0
  305. data/tools/staticdocs/img/telemetry_viewer/widgets/scrollwindow.png +0 -0
  306. data/tools/staticdocs/img/telemetry_viewer/widgets/signal.png +0 -0
  307. data/tools/staticdocs/img/telemetry_viewer/widgets/spacer.png +0 -0
  308. data/tools/staticdocs/img/telemetry_viewer/widgets/sparkline.png +0 -0
  309. data/tools/staticdocs/img/telemetry_viewer/widgets/subsetting.png +0 -0
  310. data/tools/staticdocs/img/telemetry_viewer/widgets/tabbook.png +0 -0
  311. data/tools/staticdocs/img/telemetry_viewer/widgets/tabitem.png +0 -0
  312. data/tools/staticdocs/img/telemetry_viewer/widgets/textbox.png +0 -0
  313. data/tools/staticdocs/img/telemetry_viewer/widgets/textcolor.png +0 -0
  314. data/tools/staticdocs/img/telemetry_viewer/widgets/textfield.png +0 -0
  315. data/tools/staticdocs/img/telemetry_viewer/widgets/time.png +0 -0
  316. data/tools/staticdocs/img/telemetry_viewer/widgets/title.png +0 -0
  317. data/tools/staticdocs/img/telemetry_viewer/widgets/value.png +0 -0
  318. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitsbar.png +0 -0
  319. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitscolumn.png +0 -0
  320. data/tools/staticdocs/img/telemetry_viewer/widgets/valuerangebar.png +0 -0
  321. data/tools/staticdocs/img/telemetry_viewer/widgets/vertical.png +0 -0
  322. data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
  323. data/tools/staticdocs/img/telemetry_viewer/widgets/width.png +0 -0
  324. data/tools/staticdocs/index.html +1 -13
  325. data/tools/staticdocs/lunr-index-1734474862542.json +1 -0
  326. data/tools/staticdocs/lunr-index.json +1 -1
  327. data/tools/staticdocs/markdown-page.html +2 -14
  328. data/tools/staticdocs/search-doc-1734474862542.json +1 -0
  329. data/tools/staticdocs/search-doc.json +1 -1
  330. data/tools/staticdocs/sitemap.xml +1 -1
  331. metadata +254 -99
  332. data/tools/staticdocs/assets/css/styles.80ddca08.css +0 -1
  333. data/tools/staticdocs/assets/images/cmd_authority-51594401bfa6d8cc5849aae05b4d2af838360f8a3329f9746aa1307fe3091402.png +0 -0
  334. data/tools/staticdocs/assets/images/cmd_tlm_server-727ea478568988b10e4be4a3ba7255dd48ec56f6ab6444c6c1e32497fe478681.png +0 -0
  335. data/tools/staticdocs/assets/images/collect_states-565ae4b6d02449850585afd7ce35982711d4d677f5a04c1332b2c176f1ec3a25.png +0 -0
  336. data/tools/staticdocs/assets/images/command_sender-bb1543bde21fc1963405de5251d16a80a0c3a1bf5adb5fb78145d4995e2fe541.png +0 -0
  337. data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
  338. data/tools/staticdocs/assets/images/inst_clear-2d5f985c879e8b917fedacdb8c6552bbd383231bf5c8ab8e560e77df4e050026.png +0 -0
  339. data/tools/staticdocs/assets/images/inst_collect-81bc422b3b33c5ebcbe4c2f489c730b32ab0d6ea6c7f81cc79d9f6bc03e9db15.png +0 -0
  340. data/tools/staticdocs/assets/images/inst_collect_hazardous-a8fb19ea296354a0cd276da1e0ad82f74479eea4e7e204fcf64b779596f2c092.png +0 -0
  341. data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
  342. data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
  343. data/tools/staticdocs/assets/js/019369f3.727d87f1.js +0 -1
  344. data/tools/staticdocs/assets/js/058ffc22.f2d69d72.js +0 -1
  345. data/tools/staticdocs/assets/js/0686a885.83641127.js +0 -1
  346. data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +0 -1
  347. data/tools/staticdocs/assets/js/0f5d161c.017a0733.js +0 -1
  348. data/tools/staticdocs/assets/js/0ff569c9.aa4daee5.js +0 -1
  349. data/tools/staticdocs/assets/js/103cc3be.537144c5.js +0 -1
  350. data/tools/staticdocs/assets/js/13196248.6b49e93d.js +0 -1
  351. data/tools/staticdocs/assets/js/13c1b4e4.22a0b1d4.js +0 -1
  352. data/tools/staticdocs/assets/js/1e02e6a3.0445f325.js +0 -1
  353. data/tools/staticdocs/assets/js/2047b354.25d11993.js +0 -1
  354. data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +0 -1
  355. data/tools/staticdocs/assets/js/2601.ca992ab9.js +0 -1
  356. data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +0 -1
  357. data/tools/staticdocs/assets/js/2bb7bf90.633f7a6c.js +0 -1
  358. data/tools/staticdocs/assets/js/3917.a6366d59.js +0 -1
  359. data/tools/staticdocs/assets/js/3dd7ef3b.d55880a8.js +0 -1
  360. data/tools/staticdocs/assets/js/40365d27.4b4b2ccd.js +0 -1
  361. data/tools/staticdocs/assets/js/411898ad.1d6a609d.js +0 -1
  362. data/tools/staticdocs/assets/js/42170351.d7f6034b.js +0 -1
  363. data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +0 -1
  364. data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +0 -1
  365. data/tools/staticdocs/assets/js/54d0d530.fa34b0b0.js +0 -1
  366. data/tools/staticdocs/assets/js/5723.f6123e37.js +0 -1
  367. data/tools/staticdocs/assets/js/5778.7d36f1c2.js +0 -1
  368. data/tools/staticdocs/assets/js/5b233ba7.6fdd6b6c.js +0 -1
  369. data/tools/staticdocs/assets/js/5bc719f6.daa2a049.js +0 -1
  370. data/tools/staticdocs/assets/js/5c6ce5ec.61a9cae2.js +0 -1
  371. data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +0 -1
  372. data/tools/staticdocs/assets/js/5fe211ef.0b54b37a.js +0 -1
  373. data/tools/staticdocs/assets/js/62df909c.906d9999.js +0 -1
  374. data/tools/staticdocs/assets/js/630e5448.6fea087c.js +0 -1
  375. data/tools/staticdocs/assets/js/6831b732.60c3c6d5.js +0 -1
  376. data/tools/staticdocs/assets/js/696b4199.a5ae3d65.js +0 -1
  377. data/tools/staticdocs/assets/js/6b210247.aaa91da1.js +0 -1
  378. data/tools/staticdocs/assets/js/6b65133b.76b83e83.js +0 -1
  379. data/tools/staticdocs/assets/js/6f92e431.d02304f0.js +0 -1
  380. data/tools/staticdocs/assets/js/72c6d8a8.98821dd1.js +0 -1
  381. data/tools/staticdocs/assets/js/75897369.7b31b03e.js +0 -1
  382. data/tools/staticdocs/assets/js/75e64983.6ef0928b.js +0 -1
  383. data/tools/staticdocs/assets/js/7760.7f593c4f.js +0 -2
  384. data/tools/staticdocs/assets/js/7760.7f593c4f.js.LICENSE.txt +0 -61
  385. data/tools/staticdocs/assets/js/7f5b2696.60735273.js +0 -1
  386. data/tools/staticdocs/assets/js/867640d5.48133ad5.js +0 -1
  387. data/tools/staticdocs/assets/js/89e76475.13ce283b.js +0 -1
  388. data/tools/staticdocs/assets/js/8f7843ee.7a68246a.js +0 -1
  389. data/tools/staticdocs/assets/js/9424f0b3.b6a7e150.js +0 -1
  390. data/tools/staticdocs/assets/js/97535711.5311ddd9.js +0 -1
  391. data/tools/staticdocs/assets/js/99581c43.64e9c551.js +0 -1
  392. data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +0 -1
  393. data/tools/staticdocs/assets/js/a507c363.d2cc5d72.js +0 -1
  394. data/tools/staticdocs/assets/js/a677c089.7877e85d.js +0 -1
  395. data/tools/staticdocs/assets/js/a9987364.0358fb0b.js +0 -1
  396. data/tools/staticdocs/assets/js/aa6b6c1b.9f3252e1.js +0 -1
  397. data/tools/staticdocs/assets/js/b4596165.daa24b72.js +0 -1
  398. data/tools/staticdocs/assets/js/b6d70f94.19c327f0.js +0 -1
  399. data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +0 -1
  400. data/tools/staticdocs/assets/js/bd0034eb.6691ccc4.js +0 -1
  401. data/tools/staticdocs/assets/js/c24eae19.503774e8.js +0 -1
  402. data/tools/staticdocs/assets/js/c2598f55.c5a1bac3.js +0 -1
  403. data/tools/staticdocs/assets/js/c5388ca4.f526bb0c.js +0 -1
  404. data/tools/staticdocs/assets/js/cb8c3f08.b82ad06f.js +0 -1
  405. data/tools/staticdocs/assets/js/cd879be4.f956406f.js +0 -1
  406. data/tools/staticdocs/assets/js/ce89ef36.aa518a52.js +0 -1
  407. data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +0 -1
  408. data/tools/staticdocs/assets/js/d1bfc316.28d99aa4.js +0 -1
  409. data/tools/staticdocs/assets/js/d24bf9b6.6c422113.js +0 -1
  410. data/tools/staticdocs/assets/js/d57a4b5d.8f23a506.js +0 -1
  411. data/tools/staticdocs/assets/js/d5d77c37.fb296e02.js +0 -1
  412. data/tools/staticdocs/assets/js/d8ca4191.2349d796.js +0 -1
  413. data/tools/staticdocs/assets/js/d9b92eba.8f82360d.js +0 -1
  414. data/tools/staticdocs/assets/js/db8fa1d0.b0500934.js +0 -1
  415. data/tools/staticdocs/assets/js/dc5f7beb.e3a82d1e.js +0 -1
  416. data/tools/staticdocs/assets/js/dfbae5fd.d1484e14.js +0 -1
  417. data/tools/staticdocs/assets/js/e501b0d1.0b407477.js +0 -1
  418. data/tools/staticdocs/assets/js/ebec1ccb.a1b5fc97.js +0 -1
  419. data/tools/staticdocs/assets/js/f15615f1.ee14b7d6.js +0 -1
  420. data/tools/staticdocs/assets/js/fd886806.4a41fa80.js +0 -1
  421. data/tools/staticdocs/assets/js/main.03e795fe.js +0 -2
  422. data/tools/staticdocs/assets/js/main.03e795fe.js.LICENSE.txt +0 -71
  423. data/tools/staticdocs/assets/js/runtime~main.cb8e940d.js +0 -1
  424. data/tools/staticdocs/docs/development/host-install.html +0 -38
  425. data/tools/staticdocs/docs/v5/host-install/index.html +0 -11
  426. data/tools/staticdocs/lunr-index-1730331075297.json +0 -1
  427. data/tools/staticdocs/search-doc-1730331075297.json +0 -1
data/tools/staticdocs/docs/configuration/plugins.html CHANGED
@@ -1,350 +1,359 @@
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/plugins" 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">Plugins | 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/plugins"><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="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><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/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.cb8e940d.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.03e795fe.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 menu__link--active" aria-current="page" 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" 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">Plugins</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>Plugins</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="introduction">Introduction<a href="#introduction" class="hash-link" aria-label="Direct link to Introduction" title="Direct link to Introduction">​</a></h2>
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/plugins" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Plugins | 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/plugins><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="Plugins | OpenC3 Docs"><meta data-rh=true name=description content="Plugin definition file format and keywords"><meta data-rh=true property=og:description content="Plugin definition file format and keywords"><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/plugins><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins 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 menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link 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>Plugins</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>Plugins</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=introduction>Introduction<a href=#introduction class=hash-link aria-label="Direct link to Introduction" title="Direct link to Introduction">​</a></h2>
12
2
  <p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
13
3
  <p>Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality.</p>
14
4
  <p>Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains.</p>
15
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="concepts">Concepts<a href="#concepts" class="hash-link" aria-label="Direct link to Concepts" title="Direct link to Concepts">​</a></h2>
16
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="target">Target<a href="#target" class="hash-link" aria-label="Direct link to Target" title="Direct link to Target">​</a></h3>
5
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=concepts>Concepts<a href=#concepts class=hash-link aria-label="Direct link to Concepts" title="Direct link to Concepts">​</a></h2>
6
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=target>Target<a href=#target class=hash-link aria-label="Direct link to Target" title="Direct link to Target">​</a></h3>
17
7
  <p>Targets are the external pieces of hardware and/or software that COSMOS communicates with. These are things like Front End Processors (FEPs), ground support equipment (GSE), custom software tools, and pieces of hardware like satellites themselves. A target is anything that COSMOS can send commands to and receive telemetry from.</p>
18
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="interface">Interface<a href="#interface" class="hash-link" aria-label="Direct link to Interface" title="Direct link to Interface">​</a></h3>
8
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=interface>Interface<a href=#interface class=hash-link aria-label="Direct link to Interface" title="Direct link to Interface">​</a></h3>
19
9
  <p>Interfaces implement the physical connection to one or more targets. They are typically ethernet connections implemented using TCP or UDP but can be other connections like serial ports. Interfaces send commands to targets and receive telemetry from targets.</p>
20
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="router">Router<a href="#router" class="hash-link" aria-label="Direct link to Router" title="Direct link to Router">​</a></h3>
10
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=router>Router<a href=#router class=hash-link aria-label="Direct link to Router" title="Direct link to Router">​</a></h3>
21
11
  <p>Routers flow streams of telemetry packets out of COSMOS and receive streams of commands into COSMOS. The commands are forwarded by COSMOS to associated interfaces. Telemetry comes from associated interfaces.</p>
22
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tool">Tool<a href="#tool" class="hash-link" aria-label="Direct link to Tool" title="Direct link to Tool">​</a></h3>
12
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tool>Tool<a href=#tool class=hash-link aria-label="Direct link to Tool" title="Direct link to Tool">​</a></h3>
23
13
  <p>COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts.</p>
24
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="microservice">Microservice<a href="#microservice" class="hash-link" aria-label="Direct link to Microservice" title="Direct link to Microservice">​</a></h3>
14
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=microservice>Microservice<a href=#microservice class=hash-link aria-label="Direct link to Microservice" title="Direct link to Microservice">​</a></h3>
25
15
  <p>Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks.</p>
26
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="plugin-directory-structure">Plugin Directory Structure<a href="#plugin-directory-structure" class="hash-link" aria-label="Direct link to Plugin Directory Structure" title="Direct link to Plugin Directory Structure">​</a></h2>
27
- <p>COSMOS plugins have a well-defined directory structure described in detail in the <a href="/tools/staticdocs/docs/getting-started/generators">Code Generator</a> documentation.</p>
28
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="plugintxt-configuration-file">plugin.txt Configuration File<a href="#plugintxt-configuration-file" class="hash-link" aria-label="Direct link to plugin.txt Configuration File" title="Direct link to plugin.txt Configuration File">​</a></h2>
16
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=plugin-directory-structure>Plugin Directory Structure<a href=#plugin-directory-structure class=hash-link aria-label="Direct link to Plugin Directory Structure" title="Direct link to Plugin Directory Structure">​</a></h2>
17
+ <p>COSMOS plugins have a well-defined directory structure described in detail in the <a href=/tools/staticdocs/docs/getting-started/generators>Code Generator</a> documentation.</p>
18
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=plugintxt-configuration-file>plugin.txt Configuration File<a href=#plugintxt-configuration-file class=hash-link aria-label="Direct link to plugin.txt Configuration File" title="Direct link to plugin.txt Configuration File">​</a></h2>
29
19
  <p>A plugin.txt configuration file is required for any COSMOS plugin. It declares the contents of the plugin and provides variables that allow the plugin to be configured at the time it is initially installed or upgraded.
30
20
  This file follows the standard COSMOS configuration file format of keywords followed by zero or more space separated parameters. The following keywords are supported by the plugin.txt config file:</p>
31
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="variable">VARIABLE<a href="#variable" class="hash-link" aria-label="Direct link to VARIABLE" title="Direct link to VARIABLE">​</a></h2>
21
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=variable>VARIABLE<a href=#variable class=hash-link aria-label="Direct link to VARIABLE" title="Direct link to VARIABLE">​</a></h2>
32
22
  <p><strong>Define a configurable variable for the plugin</strong></p>
33
23
  <p>The VARIABLE keyword defines a variable that will be requested for the user to enter during plugin installation. Variables can be used to handle details of targets that are user defined such as specific IP addresses and ports. Variables should also be used to allow users to rename targets to whatever name they want and support multiple installations of the same target with different names. Variables can be used later in plugin.txt or in any other configuration file included in a plugin using Ruby ERB syntax. The variables are assigned to accessible local variables in the file. At a high level, ERB allows you to run Ruby code in configuration files.</p>
34
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Variable Name</td><td>The name of the variable</td><td>True</td></tr><tr><td>Default Value</td><td>Default value of the variable</td><td>True</td></tr></tbody></table>
35
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="needs_dependencies">NEEDS_DEPENDENCIES<a href="#needs_dependencies" class="hash-link" aria-label="Direct link to NEEDS_DEPENDENCIES" title="Direct link to NEEDS_DEPENDENCIES">​</a></h2>
36
- <p></p><div class="right">(Since 5.5.0)</div><strong>Indicates the plugin needs dependencies and sets the GEM_HOME environment variable</strong><p></p>
24
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Variable Name<td>The name of the variable<td>True<tr><td>Default Value<td>Default value of the variable<td>True</table>
25
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=needs_dependencies>NEEDS_DEPENDENCIES<a href=#needs_dependencies class=hash-link aria-label="Direct link to NEEDS_DEPENDENCIES" title="Direct link to NEEDS_DEPENDENCIES">​</a></h2>
26
+ <p><div class=right>(Since 5.5.0)</div><strong>Indicates the plugin needs dependencies and sets the GEM_HOME environment variable</strong><p></p>
37
27
  <p>If the plugin has a top level lib folder or lists runtime dependencies in the gemspec, NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kubernetes pod.</p>
38
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="interface-1">INTERFACE<a href="#interface-1" class="hash-link" aria-label="Direct link to INTERFACE" title="Direct link to INTERFACE">​</a></h2>
28
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-1>INTERFACE<a href=#interface-1 class=hash-link aria-label="Direct link to INTERFACE" title="Direct link to INTERFACE">​</a></h2>
39
29
  <p><strong>Defines a connection to a physical target</strong></p>
40
30
  <p>Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby or Python file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol.</p>
41
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Interface Name</td><td>Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with &#x27;_INT&#x27; appended to the name, e.g. INST_INT for the INST target.</td><td>True</td></tr><tr><td>Filename</td><td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span></td><td>True</td></tr></tbody></table>
42
- <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
43
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="interface-modifiers">INTERFACE Modifiers<a href="#interface-modifiers" class="hash-link" aria-label="Direct link to INTERFACE Modifiers" title="Direct link to INTERFACE Modifiers">​</a></h2>
31
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Interface Name<td>Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with '_INT' appended to the name, e.g. INST_INT for the INST target.<td>True<tr><td>Filename<td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class=values>tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span><td>True</table>
32
+ <p>Additional parameters are required. Please see the <a href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
33
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=interface-modifiers>INTERFACE Modifiers<a href=#interface-modifiers class=hash-link aria-label="Direct link to INTERFACE Modifiers" title="Direct link to INTERFACE Modifiers">​</a></h2>
44
34
  <p>The following keywords must follow a INTERFACE keyword.</p>
45
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="map_target">MAP_TARGET<a href="#map_target" class="hash-link" aria-label="Direct link to MAP_TARGET" title="Direct link to MAP_TARGET">​</a></h3>
35
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=map_target>MAP_TARGET<a href=#map_target class=hash-link aria-label="Direct link to MAP_TARGET" title="Direct link to MAP_TARGET">​</a></h3>
46
36
  <p><strong>Maps a target name to an interface</strong></p>
47
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Target name to map to this interface</td><td>True</td></tr></tbody></table>
37
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Target name to map to this interface<td>True</table>
48
38
  <p>Ruby Example:</p>
49
- <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)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">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"></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>
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)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">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>
50
40
  <p>Python Example:</p>
51
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">INTERFACE DATA_INT 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"> nil BURST</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> MAP_TARGET 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"></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>
52
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="map_cmd_target">MAP_CMD_TARGET<a href="#map_cmd_target" class="hash-link" aria-label="Direct link to MAP_CMD_TARGET" title="Direct link to MAP_CMD_TARGET">​</a></h3>
53
- <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
54
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Command target name to map to this interface</td><td>True</td></tr></tbody></table>
41
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE DATA_INT 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"> nil BURST</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TARGET 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>
42
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=map_cmd_target>MAP_CMD_TARGET<a href=#map_cmd_target class=hash-link aria-label="Direct link to MAP_CMD_TARGET" title="Direct link to MAP_CMD_TARGET">​</a></h3>
43
+ <p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for commands only</strong><p></p>
44
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Command target name to map to this interface<td>True</table>
55
45
  <p>Ruby Example:</p>
56
- <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)">CMD_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_CMD_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</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
+ <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)">CMD_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_CMD_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</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>
57
47
  <p>Python Example:</p>
58
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">INTERFACE CMD_INT 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"> nil BURST</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> MAP_CMD_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</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>
59
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="map_tlm_target">MAP_TLM_TARGET<a href="#map_tlm_target" class="hash-link" aria-label="Direct link to MAP_TLM_TARGET" title="Direct link to MAP_TLM_TARGET">​</a></h3>
60
- <p></p><div class="right">(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
61
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>Telemetry target name to map to this interface</td><td>True</td></tr></tbody></table>
48
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE CMD_INT 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"> nil BURST</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_CMD_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA commands go on the CMD_INT interface</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>
49
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=map_tlm_target>MAP_TLM_TARGET<a href=#map_tlm_target class=hash-link aria-label="Direct link to MAP_TLM_TARGET" title="Direct link to MAP_TLM_TARGET">​</a></h3>
50
+ <p><div class=right>(Since 5.2.0)</div><strong>Maps a target name to an interface for telemetry only</strong><p></p>
51
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Telemetry target name to map to this interface<td>True</table>
62
52
  <p>Ruby Example:</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)">TLM_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TLM_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</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>
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)">TLM_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb host</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">docker</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">internal </span><span class="token number" style="color:rgb(247, 140, 108)">8080</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8081</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TLM_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</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
54
  <p>Python Example:</p>
65
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">INTERFACE TLM_INT 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"> nil BURST</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> MAP_TLM_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</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>
66
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="dont_connect">DONT_CONNECT<a href="#dont_connect" class="hash-link" aria-label="Direct link to DONT_CONNECT" title="Direct link to DONT_CONNECT">​</a></h3>
55
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE TLM_INT 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"> nil BURST</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TLM_TARGET DATA </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Only DATA telemetry received on TLM_INT interface</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>
56
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=dont_connect>DONT_CONNECT<a href=#dont_connect class=hash-link aria-label="Direct link to DONT_CONNECT" title="Direct link to DONT_CONNECT">​</a></h3>
67
57
  <p><strong>Server will not automatically try to connect to the interface at startup</strong></p>
68
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="dont_reconnect">DONT_RECONNECT<a href="#dont_reconnect" class="hash-link" aria-label="Direct link to DONT_RECONNECT" title="Direct link to DONT_RECONNECT">​</a></h3>
58
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=dont_reconnect>DONT_RECONNECT<a href=#dont_reconnect class=hash-link aria-label="Direct link to DONT_RECONNECT" title="Direct link to DONT_RECONNECT">​</a></h3>
69
59
  <p><strong>Server will not try to reconnect to the interface if the connection is lost</strong></p>
70
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reconnect_delay">RECONNECT_DELAY<a href="#reconnect_delay" class="hash-link" aria-label="Direct link to RECONNECT_DELAY" title="Direct link to RECONNECT_DELAY">​</a></h3>
60
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reconnect_delay>RECONNECT_DELAY<a href=#reconnect_delay class=hash-link aria-label="Direct link to RECONNECT_DELAY" title="Direct link to RECONNECT_DELAY">​</a></h3>
71
61
  <p><strong>Reconnect delay in seconds</strong></p>
72
62
  <p>If DONT_RECONNECT is not present the Server will try to reconnect to an interface if the connection is lost. Reconnect delay sets the interval in seconds between reconnect tries.</p>
73
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Delay</td><td>Delay in seconds between reconnect attempts. The default is 15 seconds.</td><td>True</td></tr></tbody></table>
74
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_disconnect">DISABLE_DISCONNECT<a href="#disable_disconnect" class="hash-link" aria-label="Direct link to DISABLE_DISCONNECT" title="Direct link to DISABLE_DISCONNECT">​</a></h3>
63
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Delay<td>Delay in seconds between reconnect attempts. The default is 15 seconds.<td>True</table>
64
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disable_disconnect>DISABLE_DISCONNECT<a href=#disable_disconnect class=hash-link aria-label="Direct link to DISABLE_DISCONNECT" title="Direct link to DISABLE_DISCONNECT">​</a></h3>
75
65
  <p><strong>Disable the Disconnect button on the Interfaces tab in the Server</strong></p>
76
- <p>Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a &#x27;production&#x27; environment where you would not want the user to inadvertently disconnect from a target.</p>
77
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_raw">LOG_RAW<a href="#log_raw" class="hash-link" aria-label="Direct link to LOG_RAW" title="Direct link to LOG_RAW">​</a></h3>
66
+ <p>Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a 'production' environment where you would not want the user to inadvertently disconnect from a target.</p>
67
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=log_raw>LOG_RAW<a href=#log_raw class=hash-link aria-label="Direct link to LOG_RAW" title="Direct link to LOG_RAW">​</a></h3>
78
68
  <p><strong>Deprecated, use LOG_STREAM</strong></p>
79
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_stream">LOG_STREAM<a href="#log_stream" class="hash-link" aria-label="Direct link to LOG_STREAM" title="Direct link to LOG_STREAM">​</a></h3>
80
- <p></p><div class="right">(Since 5.5.2)</div><strong>Log all data on the interface exactly as it is sent and received</strong><p></p>
69
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=log_stream>LOG_STREAM<a href=#log_stream class=hash-link aria-label="Direct link to LOG_STREAM" title="Direct link to LOG_STREAM">​</a></h3>
70
+ <p><div class=right>(Since 5.5.2)</div><strong>Log all data on the interface exactly as it is sent and received</strong><p></p>
81
71
  <p>LOG_STREAM does not add any OpenC3 headers and thus can not be read by OpenC3 tools. It is primarily useful for low level debugging of an interface. You will have to manually parse these logs yourself using a hex editor or other application.</p>
82
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Cycle Time</td><td>Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute.</td><td>False</td></tr><tr><td>Cycle Size</td><td>Amount of data to write before cycling the log file. Default is 50MB.</td><td>False</td></tr><tr><td>Cycle Hour</td><td>The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil.</td><td>False</td></tr><tr><td>Cycle Minute</td><td>See Cycle Hour.</td><td>False</td></tr></tbody></table>
72
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Cycle Time<td>Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute.<td>False<tr><td>Cycle Size<td>Amount of data to write before cycling the log file. Default is 50MB.<td>False<tr><td>Cycle Hour<td>The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil.<td>False<tr><td>Cycle Minute<td>See Cycle Hour.<td>False</table>
83
73
  <p>Example Usage:</p>
84
- <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)">EXAMPLE</span><span class="token plain"> example_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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Override the default log time of 600</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)">LOG_STREAM</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">60</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>
85
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="protocol">PROTOCOL<a href="#protocol" class="hash-link" aria-label="Direct link to PROTOCOL" title="Direct link to PROTOCOL">​</a></h3>
86
- <p></p><div class="right">(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
87
- <p>Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.<br><br> For information on creating your own custom protocol please see <a href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></p>
88
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>Whether to apply the protocol on incoming data, outgoing data, or both<br><br>Valid Values: <span class="values">READ, WRITE, READ_WRITE</span></td><td>True</td></tr><tr><td>Protocol Filename or Classname</td><td>Ruby or Python filename or class name which implements the protocol</td><td>True</td></tr><tr><td>Protocol specific parameters</td><td>Additional parameters used by the protocol</td><td>False</td></tr></tbody></table>
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)">EXAMPLE</span><span class="token plain"> example_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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Override the default log time of 600</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)">LOG_STREAM</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">60</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>
75
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=protocol>PROTOCOL<a href=#protocol class=hash-link aria-label="Direct link to PROTOCOL" title="Direct link to PROTOCOL">​</a></h3>
76
+ <p><div class=right>(Since 4.0.0)</div><strong>Protocols modify the interface by processing the data</strong><p></p>
77
+ <p>Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.<br><br> For information on creating your own custom protocol please see <a href=/tools/staticdocs/docs/configuration/protocols>Protocols</a></p>
78
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>Whether to apply the protocol on incoming data, outgoing data, or both<br><br>Valid Values: <span class=values>READ, WRITE, READ_WRITE</span><td>True<tr><td>Protocol Filename or Classname<td>Ruby or Python filename or class name which implements the protocol<td>True<tr><td>Protocol specific parameters<td>Additional parameters used by the protocol<td>False</table>
89
79
  <p>Ruby Example:</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)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb 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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</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"># Rather than defining the LENGTH protocol on the INTERFACE line we define it here</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> LengthProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">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><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>
80
+ <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)">DATA_INT</span><span class="token plain"> tcpip_client_interface</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb 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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAP_TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</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"># Rather than defining the LENGTH protocol on the INTERFACE line we define it here</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PROTOCOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">READ</span><span class="token plain"> LengthProtocol </span><span class="token number" style="color:rgb(247, 140, 108)">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><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
81
  <p>Python Example:</p>
92
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">INTERFACE DATA_INT 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"> nil BURST</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> MAP_TARGET DATA</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> PROTOCOL READ IgnorePacketProtocol INST IMAGE </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Drop all INST IMAGE packets</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>
93
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="option">OPTION<a href="#option" class="hash-link" aria-label="Direct link to OPTION" title="Direct link to OPTION">​</a></h3>
82
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">INTERFACE DATA_INT 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"> nil BURST</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> MAP_TARGET DATA</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> PROTOCOL READ IgnorePacketProtocol INST IMAGE </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Drop all INST IMAGE packets</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>
83
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=option>OPTION<a href=#option class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION">​</a></h3>
94
84
  <p><strong>Set a parameter on an interface</strong></p>
95
85
  <p>When an option is set the interface class calls the set_option method. Custom interfaces can override set_option to handle any additional options they want.</p>
96
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).</td><td>True</td></tr><tr><td>Parameters</td><td>Parameters to pass to the option</td><td>False</td></tr></tbody></table>
86
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0).<td>True<tr><td>Parameters<td>Parameters to pass to the option<td>False</table>
97
87
  <p>Example Usage:</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)">SERIAL_INT</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)">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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token 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)">8</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)">ROUTER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_ROUTER</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)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ROUTE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_INT</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"></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>
99
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="secret">SECRET<a href="#secret" class="hash-link" aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
100
- <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
101
- <p>Defines a secret for this interface and optionally assigns its value to an option</p>
102
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Option Name</td><td>Interface option to pass the secret value</td><td>False</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
88
+ <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)">SERIAL_INT</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)">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 keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token 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)">8</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)">ROUTER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_ROUTER</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)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2950</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10.0</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">nil</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BURST</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ROUTE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SERIAL_INT</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>
89
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=secret>SECRET<a href=#secret class=hash-link aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
90
+ <p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this interface</strong><p></p>
91
+ <p>Defines a secret for this interface and optionally assigns its value to an option. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
92
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.<td>True<tr><td>Secret Name<td>The name of the secret to retrieve from the Admin / Secrets tab. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.<td>True<tr><td>Environment Variable or File Path<td>Environment variable name or file path to store secret. Note that if you use the Option Name to set an option to the secret value, this value doesn't really matter as long as it is unique.<td>True<tr><td>Option Name<td>Interface option to pass the secret value. This is the primary way to pass secrets to interfaces.<td>False<tr><td>Secret Store Name<td>Name of the secret store for stores with multipart keys<td>False</table>
103
93
  <p>Example Usage:</p>
104
- <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)">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)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</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)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;/tmp/DATA/cert&quot;</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
105
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="env">ENV<a href="#env" class="hash-link" aria-label="Direct link to ENV" title="Direct link to ENV">​</a></h3>
106
- <p></p><div class="right">(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
107
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
94
+ <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)">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)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">USERNAME</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)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"/tmp/DATA/cert"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</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>
95
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=env>ENV<a href=#env class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV">​</a></h3>
96
+ <p><div class=right>(Since 5.7.0)</div><strong>Sets an environment variable in the microservice.</strong><p></p>
97
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>Environment variable name<td>True<tr><td>Value<td>Environment variable value<td>True</table>
108
98
  <p>Example Usage:</p>
109
- <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)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</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>
110
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="work_dir">WORK_DIR<a href="#work_dir" class="hash-link" aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR">​</a></h3>
111
- <p></p><div class="right">(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
99
+ <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)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</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>
100
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=work_dir>WORK_DIR<a href=#work_dir class=hash-link aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR">​</a></h3>
101
+ <p><div class=right>(Since 5.7.0)</div><strong>Set the working directory</strong><p></p>
112
102
  <p>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</p>
113
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
103
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Directory<td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.<td>True</table>
114
104
  <p>Example Usage:</p>
115
- <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)">WORK_DIR</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&#x27;/openc3/lib/openc3/microservices&#x27;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
116
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="port">PORT<a href="#port" class="hash-link" aria-label="Direct link to PORT" title="Direct link to PORT">​</a></h3>
117
- <p></p><div class="right">(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
105
+ <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)">WORK_DIR</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'/openc3/lib/openc3/microservices'</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>
106
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=port>PORT<a href=#port class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT">​</a></h3>
107
+ <p><div class=right>(Since 5.7.0)</div><strong>Open port for the microservice</strong><p></p>
118
108
  <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
119
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
109
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Number<td>Port number<td>True<tr><td>Protocol<td>Port protocol. Default is TCP.<td>False</table>
120
110
  <p>Example Usage:</p>
121
- <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)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</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>
122
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd">CMD<a href="#cmd" class="hash-link" aria-label="Direct link to CMD" title="Direct link to CMD">​</a></h3>
123
- <p></p><div class="right">(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
111
+ <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)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</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>
112
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd>CMD<a href=#cmd class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD">​</a></h3>
113
+ <p><div class=right>(Since 5.7.0)</div><strong>Command line to execute to run the microservice.</strong><p></p>
124
114
  <p>Command line to execute to run the microservice.</p>
125
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
115
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>One or more arguments to exec to run the microservice.<td>True</table>
126
116
  <p>Ruby Example:</p>
127
- <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)">CMD</span><span class="token plain"> ruby interface_microservice</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)">DEFAULT__INTERFACE__INT1</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>
117
+ <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)">CMD</span><span class="token plain"> ruby interface_microservice</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)">DEFAULT__INTERFACE__INT1</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>
128
118
  <p>Python Example:</p>
129
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">CMD python interface_microservice</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py DEFAULT__INTERFACE__INT1</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>
130
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="container">CONTAINER<a href="#container" class="hash-link" aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER">​</a></h3>
131
- <p></p><div class="right">(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
119
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">CMD python interface_microservice</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py DEFAULT__INTERFACE__INT1</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>
120
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=container>CONTAINER<a href=#container class=hash-link aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER">​</a></h3>
121
+ <p><div class=right>(Since 5.7.0)</div><strong>Docker Container</strong><p></p>
132
122
  <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
133
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
134
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="route_prefix">ROUTE_PREFIX<a href="#route_prefix" class="hash-link" aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX">​</a></h3>
135
- <p></p><div class="right">(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
123
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>Name of the container<td>False</table>
124
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=route_prefix>ROUTE_PREFIX<a href=#route_prefix class=hash-link aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX">​</a></h3>
125
+ <p><div class=right>(Since 5.7.0)</div><strong>Prefix of route</strong><p></p>
136
126
  <p>Prefix of route to the microservice to expose externally with Traefik</p>
137
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
127
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Route Prefix<td>Route prefix. Must be unique across all scopes. Something like /myprefix<td>True</table>
138
128
  <p>Example Usage:</p>
139
- <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)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interface</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>
140
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="router-1">ROUTER<a href="#router-1" class="hash-link" aria-label="Direct link to ROUTER" title="Direct link to ROUTER">​</a></h2>
129
+ <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)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">interface</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>
130
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=shard>SHARD<a href=#shard class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD">​</a></h3>
131
+ <p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
132
+ <p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
133
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
134
+ <p>Example Usage:</p>
135
+ <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)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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>
136
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=router-1>ROUTER<a href=#router-1 class=hash-link aria-label="Direct link to ROUTER" title="Direct link to ROUTER">​</a></h2>
141
137
  <p><strong>Create router to receive commands and output telemetry packets from one or more interfaces</strong></p>
142
138
  <p>Creates an router which receives command packets from their remote clients and sends them to associated interfaces. They receive telemetry packets from their interfaces and send them to their remote clients. This allows routers to be intermediaries between an external client and an actual device.</p>
143
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Name</td><td>Name of the router</td><td>True</td></tr><tr><td>Filename</td><td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class="values">tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span></td><td>True</td></tr></tbody></table>
144
- <p>Additional parameters are required. Please see the <a href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a> documentation for more details.</p>
145
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="target-1">TARGET<a href="#target-1" class="hash-link" aria-label="Direct link to TARGET" title="Direct link to TARGET">​</a></h2>
139
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the router<td>True<tr><td>Filename<td>Ruby or Python file to use when instantiating the interface.<br><br>Valid Values: <span class=values>tcpip_client_interface, tcpip_server_interface, udp_interface, serial_interface</span><td>True</table>
140
+ <p>Additional parameters are required. Please see the <a href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a> documentation for more details.</p>
141
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=target-1>TARGET<a href=#target-1 class=hash-link aria-label="Direct link to TARGET" title="Direct link to TARGET">​</a></h2>
146
142
  <p><strong>Defines a new target</strong></p>
147
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Folder Name</td><td>The target folder</td><td>True</td></tr><tr><td>Name</td><td>The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder.</td><td>True</td></tr></tbody></table>
143
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Folder Name<td>The target folder<td>True<tr><td>Name<td>The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder.<td>True</table>
148
144
  <p>Example Usage:</p>
149
- <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)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</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>
150
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="target-modifiers">TARGET Modifiers<a href="#target-modifiers" class="hash-link" aria-label="Direct link to TARGET Modifiers" title="Direct link to TARGET Modifiers">​</a></h2>
145
+ <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)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</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>
146
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=target-modifiers>TARGET Modifiers<a href=#target-modifiers class=hash-link aria-label="Direct link to TARGET Modifiers" title="Direct link to TARGET Modifiers">​</a></h2>
151
147
  <p>The following keywords must follow a TARGET keyword.</p>
152
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_buffer_depth">CMD_BUFFER_DEPTH<a href="#cmd_buffer_depth" class="hash-link" aria-label="Direct link to CMD_BUFFER_DEPTH" title="Direct link to CMD_BUFFER_DEPTH">​</a></h3>
153
- <p></p><div class="right">(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
154
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 5)</td><td>True</td></tr></tbody></table>
155
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_cycle_time">CMD_LOG_CYCLE_TIME<a href="#cmd_log_cycle_time" class="hash-link" aria-label="Direct link to CMD_LOG_CYCLE_TIME" title="Direct link to CMD_LOG_CYCLE_TIME">​</a></h3>
148
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_buffer_depth>CMD_BUFFER_DEPTH<a href=#cmd_buffer_depth class=hash-link aria-label="Direct link to CMD_BUFFER_DEPTH" title="Direct link to CMD_BUFFER_DEPTH">​</a></h3>
149
+ <p><div class=right>(Since 5.2.0)</div><strong>Number of commands to buffer to ensure logged in order</strong><p></p>
150
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Buffer Depth<td>Buffer depth in packets (Default = 5)<td>True</table>
151
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_log_cycle_time>CMD_LOG_CYCLE_TIME<a href=#cmd_log_cycle_time class=hash-link aria-label="Direct link to CMD_LOG_CYCLE_TIME" title="Direct link to CMD_LOG_CYCLE_TIME">​</a></h3>
156
152
  <p><strong>Command binary logs can be cycled on a time interval.</strong></p>
157
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
158
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_cycle_size">CMD_LOG_CYCLE_SIZE<a href="#cmd_log_cycle_size" class="hash-link" aria-label="Direct link to CMD_LOG_CYCLE_SIZE" title="Direct link to CMD_LOG_CYCLE_SIZE">​</a></h3>
153
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
154
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_log_cycle_size>CMD_LOG_CYCLE_SIZE<a href=#cmd_log_cycle_size class=hash-link aria-label="Direct link to CMD_LOG_CYCLE_SIZE" title="Direct link to CMD_LOG_CYCLE_SIZE">​</a></h3>
159
155
  <p><strong>Command binary logs can be cycled after a certain log file size is reached.</strong></p>
160
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
161
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_log_retain_time">CMD_LOG_RETAIN_TIME<a href="#cmd_log_retain_time" class="hash-link" aria-label="Direct link to CMD_LOG_RETAIN_TIME" title="Direct link to CMD_LOG_RETAIN_TIME">​</a></h3>
156
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
157
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_log_retain_time>CMD_LOG_RETAIN_TIME<a href=#cmd_log_retain_time class=hash-link aria-label="Direct link to CMD_LOG_RETAIN_TIME" title="Direct link to CMD_LOG_RETAIN_TIME">​</a></h3>
162
158
  <p><strong>How long to keep raw command logs in seconds.</strong></p>
163
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
164
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_cycle_time">CMD_DECOM_LOG_CYCLE_TIME<a href="#cmd_decom_log_cycle_time" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_CYCLE_TIME" title="Direct link to CMD_DECOM_LOG_CYCLE_TIME">​</a></h3>
159
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep raw command logs (default = nil = Forever)<td>True</table>
160
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_decom_log_cycle_time>CMD_DECOM_LOG_CYCLE_TIME<a href=#cmd_decom_log_cycle_time class=hash-link aria-label="Direct link to CMD_DECOM_LOG_CYCLE_TIME" title="Direct link to CMD_DECOM_LOG_CYCLE_TIME">​</a></h3>
165
161
  <p><strong>Command decommutation logs can be cycled on a time interval.</strong></p>
166
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
167
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_cycle_size">CMD_DECOM_LOG_CYCLE_SIZE<a href="#cmd_decom_log_cycle_size" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_CYCLE_SIZE" title="Direct link to CMD_DECOM_LOG_CYCLE_SIZE">​</a></h3>
162
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
163
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_decom_log_cycle_size>CMD_DECOM_LOG_CYCLE_SIZE<a href=#cmd_decom_log_cycle_size class=hash-link aria-label="Direct link to CMD_DECOM_LOG_CYCLE_SIZE" title="Direct link to CMD_DECOM_LOG_CYCLE_SIZE">​</a></h3>
168
164
  <p><strong>Command decommutation logs can be cycled after a certain log file size is reached.</strong></p>
169
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
170
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd_decom_log_retain_time">CMD_DECOM_LOG_RETAIN_TIME<a href="#cmd_decom_log_retain_time" class="hash-link" aria-label="Direct link to CMD_DECOM_LOG_RETAIN_TIME" title="Direct link to CMD_DECOM_LOG_RETAIN_TIME">​</a></h3>
165
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
166
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd_decom_log_retain_time>CMD_DECOM_LOG_RETAIN_TIME<a href=#cmd_decom_log_retain_time class=hash-link aria-label="Direct link to CMD_DECOM_LOG_RETAIN_TIME" title="Direct link to CMD_DECOM_LOG_RETAIN_TIME">​</a></h3>
171
167
  <p><strong>How long to keep decom command logs in seconds.</strong></p>
172
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom command logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
173
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_buffer_depth">TLM_BUFFER_DEPTH<a href="#tlm_buffer_depth" class="hash-link" aria-label="Direct link to TLM_BUFFER_DEPTH" title="Direct link to TLM_BUFFER_DEPTH">​</a></h3>
174
- <p></p><div class="right">(Since 5.2.0)</div><strong>Number of telemetry packets to buffer to ensure logged in order</strong><p></p>
175
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Buffer Depth</td><td>Buffer depth in packets (Default = 60)</td><td>True</td></tr></tbody></table>
176
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_cycle_time">TLM_LOG_CYCLE_TIME<a href="#tlm_log_cycle_time" class="hash-link" aria-label="Direct link to TLM_LOG_CYCLE_TIME" title="Direct link to TLM_LOG_CYCLE_TIME">​</a></h3>
168
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep decom command logs (default = nil = Forever)<td>True</table>
169
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_buffer_depth>TLM_BUFFER_DEPTH<a href=#tlm_buffer_depth class=hash-link aria-label="Direct link to TLM_BUFFER_DEPTH" title="Direct link to TLM_BUFFER_DEPTH">​</a></h3>
170
+ <p><div class=right>(Since 5.2.0)</div><strong>Number of telemetry packets to buffer to ensure logged in order</strong><p></p>
171
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Buffer Depth<td>Buffer depth in packets (Default = 60)<td>True</table>
172
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_log_cycle_time>TLM_LOG_CYCLE_TIME<a href=#tlm_log_cycle_time class=hash-link aria-label="Direct link to TLM_LOG_CYCLE_TIME" title="Direct link to TLM_LOG_CYCLE_TIME">​</a></h3>
177
173
  <p><strong>Telemetry binary logs can be cycled on a time interval.</strong></p>
178
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
179
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_cycle_size">TLM_LOG_CYCLE_SIZE<a href="#tlm_log_cycle_size" class="hash-link" aria-label="Direct link to TLM_LOG_CYCLE_SIZE" title="Direct link to TLM_LOG_CYCLE_SIZE">​</a></h3>
174
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
175
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_log_cycle_size>TLM_LOG_CYCLE_SIZE<a href=#tlm_log_cycle_size class=hash-link aria-label="Direct link to TLM_LOG_CYCLE_SIZE" title="Direct link to TLM_LOG_CYCLE_SIZE">​</a></h3>
180
176
  <p><strong>Telemetry binary logs can be cycled after a certain log file size is reached.</strong></p>
181
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
182
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_log_retain_time">TLM_LOG_RETAIN_TIME<a href="#tlm_log_retain_time" class="hash-link" aria-label="Direct link to TLM_LOG_RETAIN_TIME" title="Direct link to TLM_LOG_RETAIN_TIME">​</a></h3>
177
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
178
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_log_retain_time>TLM_LOG_RETAIN_TIME<a href=#tlm_log_retain_time class=hash-link aria-label="Direct link to TLM_LOG_RETAIN_TIME" title="Direct link to TLM_LOG_RETAIN_TIME">​</a></h3>
183
179
  <p><strong>How long to keep raw telemetry logs in seconds.</strong></p>
184
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep raw telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
185
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_cycle_time">TLM_DECOM_LOG_CYCLE_TIME<a href="#tlm_decom_log_cycle_time" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_CYCLE_TIME" title="Direct link to TLM_DECOM_LOG_CYCLE_TIME">​</a></h3>
180
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep raw telemetry logs (default = nil = Forever)<td>True</table>
181
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_decom_log_cycle_time>TLM_DECOM_LOG_CYCLE_TIME<a href=#tlm_decom_log_cycle_time class=hash-link aria-label="Direct link to TLM_DECOM_LOG_CYCLE_TIME" title="Direct link to TLM_DECOM_LOG_CYCLE_TIME">​</a></h3>
186
182
  <p><strong>Telemetry decommutation logs can be cycled on a time interval.</strong></p>
187
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Maximum time between files in seconds (default = 600)</td><td>True</td></tr></tbody></table>
188
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_cycle_size">TLM_DECOM_LOG_CYCLE_SIZE<a href="#tlm_decom_log_cycle_size" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_CYCLE_SIZE" title="Direct link to TLM_DECOM_LOG_CYCLE_SIZE">​</a></h3>
183
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Maximum time between files in seconds (default = 600)<td>True</table>
184
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_decom_log_cycle_size>TLM_DECOM_LOG_CYCLE_SIZE<a href=#tlm_decom_log_cycle_size class=hash-link aria-label="Direct link to TLM_DECOM_LOG_CYCLE_SIZE" title="Direct link to TLM_DECOM_LOG_CYCLE_SIZE">​</a></h3>
189
185
  <p><strong>Telemetry decommutation logs can be cycled after a certain log file size is reached.</strong></p>
190
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Size</td><td>Maximum file size in bytes (default = 50_000_000)</td><td>True</td></tr></tbody></table>
191
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="tlm_decom_log_retain_time">TLM_DECOM_LOG_RETAIN_TIME<a href="#tlm_decom_log_retain_time" class="hash-link" aria-label="Direct link to TLM_DECOM_LOG_RETAIN_TIME" title="Direct link to TLM_DECOM_LOG_RETAIN_TIME">​</a></h3>
186
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Size<td>Maximum file size in bytes (default = 50_000_000)<td>True</table>
187
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=tlm_decom_log_retain_time>TLM_DECOM_LOG_RETAIN_TIME<a href=#tlm_decom_log_retain_time class=hash-link aria-label="Direct link to TLM_DECOM_LOG_RETAIN_TIME" title="Direct link to TLM_DECOM_LOG_RETAIN_TIME">​</a></h3>
192
188
  <p><strong>How long to keep decom telemetry logs in seconds.</strong></p>
193
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep decom telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
194
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_minute_log_retain_time">REDUCED_MINUTE_LOG_RETAIN_TIME<a href="#reduced_minute_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME" title="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME">​</a></h3>
189
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep decom telemetry logs (default = nil = Forever)<td>True</table>
190
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reduced_minute_log_retain_time>REDUCED_MINUTE_LOG_RETAIN_TIME<a href=#reduced_minute_log_retain_time class=hash-link aria-label="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME" title="Direct link to REDUCED_MINUTE_LOG_RETAIN_TIME">​</a></h3>
195
191
  <p><strong>How long to keep reduced minute telemetry logs in seconds.</strong></p>
196
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
197
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_hour_log_retain_time">REDUCED_HOUR_LOG_RETAIN_TIME<a href="#reduced_hour_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME" title="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME">​</a></h3>
192
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)<td>True</table>
193
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reduced_hour_log_retain_time>REDUCED_HOUR_LOG_RETAIN_TIME<a href=#reduced_hour_log_retain_time class=hash-link aria-label="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME" title="Direct link to REDUCED_HOUR_LOG_RETAIN_TIME">​</a></h3>
198
194
  <p><strong>How long to keep reduced hour telemetry logs in seconds.</strong></p>
199
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
200
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_day_log_retain_time">REDUCED_DAY_LOG_RETAIN_TIME<a href="#reduced_day_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_DAY_LOG_RETAIN_TIME" title="Direct link to REDUCED_DAY_LOG_RETAIN_TIME">​</a></h3>
195
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)<td>True</table>
196
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reduced_day_log_retain_time>REDUCED_DAY_LOG_RETAIN_TIME<a href=#reduced_day_log_retain_time class=hash-link aria-label="Direct link to REDUCED_DAY_LOG_RETAIN_TIME" title="Direct link to REDUCED_DAY_LOG_RETAIN_TIME">​</a></h3>
201
197
  <p><strong>How long to keep reduced day telemetry logs in seconds.</strong></p>
202
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep reduced day telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
203
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="log_retain_time">LOG_RETAIN_TIME<a href="#log_retain_time" class="hash-link" aria-label="Direct link to LOG_RETAIN_TIME" title="Direct link to LOG_RETAIN_TIME">​</a></h3>
198
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep reduced day telemetry logs (default = nil = Forever)<td>True</table>
199
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=log_retain_time>LOG_RETAIN_TIME<a href=#log_retain_time class=hash-link aria-label="Direct link to LOG_RETAIN_TIME" title="Direct link to LOG_RETAIN_TIME">​</a></h3>
204
200
  <p><strong>How long to keep all regular telemetry logs in seconds.</strong></p>
205
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all regular telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
206
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reduced_log_retain_time">REDUCED_LOG_RETAIN_TIME<a href="#reduced_log_retain_time" class="hash-link" aria-label="Direct link to REDUCED_LOG_RETAIN_TIME" title="Direct link to REDUCED_LOG_RETAIN_TIME">​</a></h3>
201
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep all regular telemetry logs (default = nil = Forever)<td>True</table>
202
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reduced_log_retain_time>REDUCED_LOG_RETAIN_TIME<a href=#reduced_log_retain_time class=hash-link aria-label="Direct link to REDUCED_LOG_RETAIN_TIME" title="Direct link to REDUCED_LOG_RETAIN_TIME">​</a></h3>
207
203
  <p><strong>How long to keep all reduced telemetry logs in seconds.</strong></p>
208
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds to keep all reduced telemetry logs (default = nil = Forever)</td><td>True</td></tr></tbody></table>
209
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cleanup_poll_time">CLEANUP_POLL_TIME<a href="#cleanup_poll_time" class="hash-link" aria-label="Direct link to CLEANUP_POLL_TIME" title="Direct link to CLEANUP_POLL_TIME">​</a></h3>
204
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds to keep all reduced telemetry logs (default = nil = Forever)<td>True</table>
205
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cleanup_poll_time>CLEANUP_POLL_TIME<a href=#cleanup_poll_time class=hash-link aria-label="Direct link to CLEANUP_POLL_TIME" title="Direct link to CLEANUP_POLL_TIME">​</a></h3>
210
206
  <p><strong>Period at which to run the cleanup process.</strong></p>
211
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Time</td><td>Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)</td><td>True</td></tr></tbody></table>
212
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reducer_disable">REDUCER_DISABLE<a href="#reducer_disable" class="hash-link" aria-label="Direct link to REDUCER_DISABLE" title="Direct link to REDUCER_DISABLE">​</a></h3>
207
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Time<td>Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)<td>True</table>
208
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reducer_disable>REDUCER_DISABLE<a href=#reducer_disable class=hash-link aria-label="Direct link to REDUCER_DISABLE" title="Direct link to REDUCER_DISABLE">​</a></h3>
213
209
  <p><strong>Disables the data reduction microservice for the target</strong></p>
214
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="reducer_max_cpu_utilization">REDUCER_MAX_CPU_UTILIZATION<a href="#reducer_max_cpu_utilization" class="hash-link" aria-label="Direct link to REDUCER_MAX_CPU_UTILIZATION" title="Direct link to REDUCER_MAX_CPU_UTILIZATION">​</a></h3>
210
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=reducer_max_cpu_utilization>REDUCER_MAX_CPU_UTILIZATION<a href=#reducer_max_cpu_utilization class=hash-link aria-label="Direct link to REDUCER_MAX_CPU_UTILIZATION" title="Direct link to REDUCER_MAX_CPU_UTILIZATION">​</a></h3>
215
211
  <p><strong>Maximum amount of CPU utilization to apply to data reduction</strong></p>
216
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Percentage</td><td>0 to 100 percent (default = 30)</td><td>True</td></tr></tbody></table>
217
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="target_microservice">TARGET_MICROSERVICE<a href="#target_microservice" class="hash-link" aria-label="Direct link to TARGET_MICROSERVICE" title="Direct link to TARGET_MICROSERVICE">​</a></h3>
218
- <p></p><div class="right">(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
212
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Percentage<td>0 to 100 percent (default = 30)<td>True</table>
213
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=target_microservice>TARGET_MICROSERVICE<a href=#target_microservice class=hash-link aria-label="Direct link to TARGET_MICROSERVICE" title="Direct link to TARGET_MICROSERVICE">​</a></h3>
214
+ <p><div class=right>(Since 5.2.0)</div><strong>Breaks a target microservice out into its own process.</strong><p></p>
219
215
  <p>Can be used to give more resources to processing that is falling behind. If defined multiple times for the same type, will create multiple processes. Each process can be given specific packets to process with the PACKET keyword.</p>
220
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP</td><td>True</td></tr></tbody></table>
221
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="packet">PACKET<a href="#packet" class="hash-link" aria-label="Direct link to PACKET" title="Direct link to PACKET">​</a></h3>
222
- <p></p><div class="right">(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
223
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Packet Name</td><td>The packet name. Does not apply to REDUCER or CLEANUP target microservice types.</td><td>True</td></tr></tbody></table>
224
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb">DISABLE_ERB<a href="#disable_erb" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
225
- <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
216
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP<td>True</table>
217
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=packet>PACKET<a href=#packet class=hash-link aria-label="Direct link to PACKET" title="Direct link to PACKET">​</a></h3>
218
+ <p><div class=right>(Since 5.2.0)</div><strong>Packet Name to allocate to the current TARGET_MICROSERVICE.</strong><p></p>
219
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Packet Name<td>The packet name. Does not apply to REDUCER or CLEANUP target microservice types.<td>True</table>
220
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disable_erb>DISABLE_ERB<a href=#disable_erb class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
221
+ <p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
226
222
  <p>Disable ERB processing for the entire target or a set of regular expressions over its filenames</p>
227
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
228
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="microservice-1">MICROSERVICE<a href="#microservice-1" class="hash-link" aria-label="Direct link to MICROSERVICE" title="Direct link to MICROSERVICE">​</a></h2>
223
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
224
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=shard-1>SHARD<a href=#shard-1 class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD">​</a></h3>
225
+ <p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
226
+ <p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
227
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
228
+ <p>Example Usage:</p>
229
+ <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)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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>
230
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=microservice-1>MICROSERVICE<a href=#microservice-1 class=hash-link aria-label="Direct link to MICROSERVICE" title="Direct link to MICROSERVICE">​</a></h2>
229
231
  <p><strong>Defines a new microservice</strong></p>
230
232
  <p>Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.</p>
231
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Microservice Folder Name</td><td>The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName</td><td>True</td></tr><tr><td>Microservice Name</td><td>The specific name of this instance of the microservice in the OpenC3 system</td><td>True</td></tr></tbody></table>
233
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Microservice Folder Name<td>The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName<td>True<tr><td>Microservice Name<td>The specific name of this instance of the microservice in the OpenC3 system<td>True</table>
232
234
  <p>Example Usage:</p>
233
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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>
234
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="microservice-modifiers">MICROSERVICE Modifiers<a href="#microservice-modifiers" class="hash-link" aria-label="Direct link to MICROSERVICE Modifiers" title="Direct link to MICROSERVICE Modifiers">​</a></h2>
235
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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>
236
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=microservice-modifiers>MICROSERVICE Modifiers<a href=#microservice-modifiers class=hash-link aria-label="Direct link to MICROSERVICE Modifiers" title="Direct link to MICROSERVICE Modifiers">​</a></h2>
235
237
  <p>The following keywords must follow a MICROSERVICE keyword.</p>
236
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="env-1">ENV<a href="#env-1" class="hash-link" aria-label="Direct link to ENV" title="Direct link to ENV">​</a></h3>
238
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=env-1>ENV<a href=#env-1 class=hash-link aria-label="Direct link to ENV" title="Direct link to ENV">​</a></h3>
237
239
  <p><strong>Sets an environment variable in the microservice.</strong></p>
238
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Key</td><td>Environment variable name</td><td>True</td></tr><tr><td>Value</td><td>Environment variable value</td><td>True</td></tr></tbody></table>
240
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>Environment variable name<td>True<tr><td>Value<td>Environment variable value<td>True</table>
239
241
  <p>Example Usage:</p>
240
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</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>
241
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="work_dir-1">WORK_DIR<a href="#work_dir-1" class="hash-link" aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR">​</a></h3>
242
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">ENV</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">COMPANY</span><span class="token plain"> OpenC3</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>
243
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=work_dir-1>WORK_DIR<a href=#work_dir-1 class=hash-link aria-label="Direct link to WORK_DIR" title="Direct link to WORK_DIR">​</a></h3>
242
244
  <p><strong>Set the working directory</strong></p>
243
245
  <p>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</p>
244
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Directory</td><td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.</td><td>True</td></tr></tbody></table>
246
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Directory<td>Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.<td>True</table>
245
247
  <p>Example Usage:</p>
246
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">WORK_DIR</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</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>
247
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="port-1">PORT<a href="#port-1" class="hash-link" aria-label="Direct link to PORT" title="Direct link to PORT">​</a></h3>
248
- <p></p><div class="right">(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
248
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">WORK_DIR</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</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>
249
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=port-1>PORT<a href=#port-1 class=hash-link aria-label="Direct link to PORT" title="Direct link to PORT">​</a></h3>
250
+ <p><div class=right>(Since 5.0.10)</div><strong>Open port for the microservice</strong><p></p>
249
251
  <p>Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support</p>
250
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Number</td><td>Port number</td><td>True</td></tr><tr><td>Protocol</td><td>Port protocol. Default is TCP.</td><td>False</td></tr></tbody></table>
252
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Number<td>Port number<td>True<tr><td>Protocol<td>Port protocol. Default is TCP.<td>False</table>
251
253
  <p>Example Usage:</p>
252
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</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>
253
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="topic">TOPIC<a href="#topic" class="hash-link" aria-label="Direct link to TOPIC" title="Direct link to TOPIC">​</a></h3>
254
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">PORT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">7272</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>
255
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=topic>TOPIC<a href=#topic class=hash-link aria-label="Direct link to TOPIC" title="Direct link to TOPIC">​</a></h3>
254
256
  <p><strong>Associate a Redis topic</strong></p>
255
257
  <p>Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics.</p>
256
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Topic Name</td><td>Redis Topic to associate with the microservice</td><td>True</td></tr></tbody></table>
258
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Topic Name<td>Redis Topic to associate with the microservice<td>True</table>
257
259
  <p>Example Usage:</p>
258
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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"># Manually assigning topics is an advanced topic and requires</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"># intimate knowledge of the internal COSMOS data structures.</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)">TOPIC</span><span class="token plain"> DEFAULT__openc3_log_messages</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)">TOPIC</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT__TELEMETRY__EXAMPLE__STATUS</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>
259
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="target_name">TARGET_NAME<a href="#target_name" class="hash-link" aria-label="Direct link to TARGET_NAME" title="Direct link to TARGET_NAME">​</a></h3>
260
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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"># Manually assigning topics is an advanced topic and requires</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"># intimate knowledge of the internal COSMOS data structures.</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)">TOPIC</span><span class="token plain"> DEFAULT__openc3_log_messages</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)">TOPIC</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT__TELEMETRY__EXAMPLE__STATUS</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>
261
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=target_name>TARGET_NAME<a href=#target_name class=hash-link aria-label="Direct link to TARGET_NAME" title="Direct link to TARGET_NAME">​</a></h3>
260
262
  <p><strong>Associate a OpenC3 target</strong></p>
261
263
  <p>OpenC3 target to associate with the microservice. For standard OpenC3 microservices such as decom_microservice this causes the target configuration to get loaded into the container for the microservice.</p>
262
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Target Name</td><td>OpenC3 target to associate with the microservice</td><td>True</td></tr></tbody></table>
264
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>OpenC3 target to associate with the microservice<td>True</table>
263
265
  <p>Example Usage:</p>
264
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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_NAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</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>
265
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cmd-1">CMD<a href="#cmd-1" class="hash-link" aria-label="Direct link to CMD" title="Direct link to CMD">​</a></h3>
266
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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_NAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</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>
267
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=cmd-1>CMD<a href=#cmd-1 class=hash-link aria-label="Direct link to CMD" title="Direct link to CMD">​</a></h3>
266
268
  <p><strong>Command line to execute to run the microservice.</strong></p>
267
269
  <p>Command line to execute to run the microservice.</p>
268
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>One or more arguments to exec to run the microservice.</td><td>True</td></tr></tbody></table>
270
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>One or more arguments to exec to run the microservice.<td>True</table>
269
271
  <p>Ruby Example:</p>
270
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">CMD</span><span class="token plain"> ruby example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</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>
272
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">EXAMPLE</span><span class="token plain"> openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</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)">CMD</span><span class="token plain"> ruby example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</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>
271
273
  <p>Python Example:</p>
272
- <div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">MICROSERVICE EXAMPLE openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> CMD python example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</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>
273
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="option-1">OPTION<a href="#option-1" class="hash-link" aria-label="Direct link to OPTION" title="Direct link to OPTION">​</a></h3>
274
+ <div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">MICROSERVICE EXAMPLE openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token plain">example</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> CMD python example_target</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</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>
275
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=option-1>OPTION<a href=#option-1 class=hash-link aria-label="Direct link to OPTION" title="Direct link to OPTION">​</a></h3>
274
276
  <p><strong>Pass an option to the microservice</strong></p>
275
277
  <p>Generic key/value(s) options to pass to the microservice. These take the form of KEYWORD/PARAMS like a line in a OpenC3 configuration file. Multiple OPTION keywords can be used to pass multiple options to the microservice.</p>
276
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Option Name</td><td>Name of the option</td><td>True</td></tr><tr><td>Option Value(s)</td><td>One or more values to associate with the option</td><td>True</td></tr></tbody></table>
277
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="container-1">CONTAINER<a href="#container-1" class="hash-link" aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER">​</a></h3>
278
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Option Name<td>Name of the option<td>True<tr><td>Option Value(s)<td>One or more values to associate with the option<td>True</table>
279
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=container-1>CONTAINER<a href=#container-1 class=hash-link aria-label="Direct link to CONTAINER" title="Direct link to CONTAINER">​</a></h3>
278
280
  <p><strong>Docker Container</strong></p>
279
281
  <p>Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.</p>
280
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Args</td><td>Name of the container</td><td>False</td></tr></tbody></table>
281
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="secret-1">SECRET<a href="#secret-1" class="hash-link" aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
282
- <p></p><div class="right">(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
283
- <p>Defines a secret for this microservice</p>
284
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Type</td><td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.</td><td>True</td></tr><tr><td>Secret Name</td><td>The name of the secret to retrieve</td><td>True</td></tr><tr><td>Environment Variable or File Path</td><td>Environment variable name or file path to store secret</td><td>True</td></tr><tr><td>Secret Store Name</td><td>Name of the secret store for stores with multipart keys</td><td>False</td></tr></tbody></table>
282
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Args<td>Name of the container<td>False</table>
283
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=secret-1>SECRET<a href=#secret-1 class=hash-link aria-label="Direct link to SECRET" title="Direct link to SECRET">​</a></h3>
284
+ <p><div class=right>(Since 5.3.0)</div><strong>Define a secret needed by this microservice</strong><p></p>
285
+ <p>Defines a secret for this microservice. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.</p>
286
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Type<td>ENV or FILE. ENV will mount the secret into an environment variable. FILE mounts the secret into a file.<td>True<tr><td>Secret Name<td>The name of the secret to retrieve from the Admin / Secrets tab. For more information see <a href=/tools/staticdocs/docs/tools/admin#secrets>Admin Secrets</a>.<td>True<tr><td>Environment Variable or File Path<td>Environment variable name or file path to store secret<td>True<tr><td>Secret Store Name<td>Name of the secret store for stores with multipart keys<td>False</table>
285
287
  <p>Example Usage:</p>
286
- <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)">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)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</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)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">&quot;/tmp/DATA/cert&quot;</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
287
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="route_prefix-1">ROUTE_PREFIX<a href="#route_prefix-1" class="hash-link" aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX">​</a></h3>
288
- <p></p><div class="right">(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
288
+ <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)">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)">USERNAME</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENV_USERNAME</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)">FILE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"/tmp/DATA/cert"</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>
289
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=route_prefix-1>ROUTE_PREFIX<a href=#route_prefix-1 class=hash-link aria-label="Direct link to ROUTE_PREFIX" title="Direct link to ROUTE_PREFIX">​</a></h3>
290
+ <p><div class=right>(Since 5.5.0)</div><strong>Prefix of route</strong><p></p>
289
291
  <p>Prefix of route to the microservice to expose externally with Traefik</p>
290
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Route Prefix</td><td>Route prefix. Must be unique across all scopes. Something like /myprefix</td><td>True</td></tr></tbody></table>
292
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Route Prefix<td>Route prefix. Must be unique across all scopes. Something like /myprefix<td>True</table>
291
293
  <p>Example Usage:</p>
292
- <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</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)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">cfdp</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>
293
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb-1">DISABLE_ERB<a href="#disable_erb-1" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
294
- <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
294
+ <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)">MICROSERVICE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CFDP</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)">ROUTE_PREFIX</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">cfdp</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>
295
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disable_erb-1>DISABLE_ERB<a href=#disable_erb-1 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
296
+ <p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
295
297
  <p>Disable ERB processing for the entire microservice or a set of regular expressions over its filenames</p>
296
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
297
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="tool-1">TOOL<a href="#tool-1" class="hash-link" aria-label="Direct link to TOOL" title="Direct link to TOOL">​</a></h2>
298
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
299
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=shard-2>SHARD<a href=#shard-2 class=hash-link aria-label="Direct link to SHARD" title="Direct link to SHARD">​</a></h3>
300
+ <p><div class=right>(Since 6.0.0)</div><strong>Operator shard to run target microservices on</strong><p></p>
301
+ <p>Operator Shard. Only used if running multiple operator containers typically in Kubernetes</p>
302
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shard<td>Shard number starting from 0<td>False</table>
303
+ <p>Example Usage:</p>
304
+ <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)">SHARD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</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>
305
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=tool-1>TOOL<a href=#tool-1 class=hash-link aria-label="Direct link to TOOL" title="Direct link to TOOL">​</a></h2>
298
306
  <p><strong>Define a tool</strong></p>
299
307
  <p>Defines a tool that the plugin adds to the OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices.</p>
300
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Tool Folder Name</td><td>The exact name of the tool folder in the plugin. ie. tools/ToolFolderName</td><td>True</td></tr><tr><td>Tool Name</td><td>Name of the tool that is displayed in the OpenC3 Navigation menu</td><td>True</td></tr></tbody></table>
308
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Tool Folder Name<td>The exact name of the tool folder in the plugin. ie. tools/ToolFolderName<td>True<tr><td>Tool Name<td>Name of the tool that is displayed in the OpenC3 Navigation menu<td>True</table>
301
309
  <p>Example Usage:</p>
302
- <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)">TOOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEMO</span><span class="token plain"> Demo</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>
303
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="tool-modifiers">TOOL Modifiers<a href="#tool-modifiers" class="hash-link" aria-label="Direct link to TOOL Modifiers" title="Direct link to TOOL Modifiers">​</a></h2>
310
+ <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)">TOOL</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEMO</span><span class="token plain"> Demo</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>
311
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=tool-modifiers>TOOL Modifiers<a href=#tool-modifiers class=hash-link aria-label="Direct link to TOOL Modifiers" title="Direct link to TOOL Modifiers">​</a></h2>
304
312
  <p>The following keywords must follow a TOOL keyword.</p>
305
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="url">URL<a href="#url" class="hash-link" aria-label="Direct link to URL" title="Direct link to URL">​</a></h3>
313
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=url>URL<a href=#url class=hash-link aria-label="Direct link to URL" title="Direct link to URL">​</a></h3>
306
314
  <p><strong>Url used to access the tool</strong></p>
307
- <p>The relative url used to access the tool. Defaults to &quot;/tools/ToolFolderName&quot;.</p>
308
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.</td><td>True</td></tr></tbody></table>
309
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="inline_url">INLINE_URL<a href="#inline_url" class="hash-link" aria-label="Direct link to INLINE_URL" title="Direct link to INLINE_URL">​</a></h3>
315
+ <p>The relative url used to access the tool. Defaults to "/tools/ToolFolderName".</p>
316
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Url<td>The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.<td>True</table>
317
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=inline_url>INLINE_URL<a href=#inline_url class=hash-link aria-label="Direct link to INLINE_URL" title="Direct link to INLINE_URL">​</a></h3>
310
318
  <p><strong>Internal url to load a tool</strong></p>
311
- <p>The url of the javascript file used to load the tool into single-SPA. Defaults to &quot;js/app.js&quot;.</p>
312
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Url</td><td>The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename.</td><td>True</td></tr></tbody></table>
313
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="window">WINDOW<a href="#window" class="hash-link" aria-label="Direct link to WINDOW" title="Direct link to WINDOW">​</a></h3>
319
+ <p>The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".</p>
320
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Url<td>The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename.<td>True</table>
321
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=window>WINDOW<a href=#window class=hash-link aria-label="Direct link to WINDOW" title="Direct link to WINDOW">​</a></h3>
314
322
  <p><strong>How to display the tool when navigated to</strong></p>
315
323
  <p>The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within OpenC3. NEW opens the tool in a new TAB.</p>
316
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Window Mode</td><td>Tool display mode<br><br>Valid Values: <span class="values">INLINE, IFRAME, NEW</span></td><td>True</td></tr></tbody></table>
317
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="icon">ICON<a href="#icon" class="hash-link" aria-label="Direct link to ICON" title="Direct link to ICON">​</a></h3>
324
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Window Mode<td>Tool display mode<br><br>Valid Values: <span class=values>INLINE, IFRAME, NEW</span><td>True</table>
325
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=icon>ICON<a href=#icon class=hash-link aria-label="Direct link to ICON" title="Direct link to ICON">​</a></h3>
318
326
  <p><strong>Set tool icon</strong></p>
319
327
  <p>Icon shown next to the tool name in the OpenC3 navigation menu.</p>
320
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Icon Name</td><td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href="https://materialdesignicons.com/" target="_blank" rel="noopener noreferrer">https://materialdesignicons.com/</a>), and Astro.</td><td>True</td></tr></tbody></table>
321
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="category">CATEGORY<a href="#category" class="hash-link" aria-label="Direct link to CATEGORY" title="Direct link to CATEGORY">​</a></h3>
328
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Icon Name<td>Icon to display next to the tool name. Icons come from Font Awesome, Material Design (<a href=https://materialdesignicons.com/ target=_blank rel="noopener noreferrer">https://materialdesignicons.com/</a>), and Astro.<td>True</table>
329
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=category>CATEGORY<a href=#category class=hash-link aria-label="Direct link to CATEGORY" title="Direct link to CATEGORY">​</a></h3>
322
330
  <p><strong>Category for the tool</strong></p>
323
331
  <p>Associates the tool with a category which becomes a submenu in the Navigation menu.</p>
324
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Category Name</td><td>Category to associate the tool with</td><td>True</td></tr></tbody></table>
325
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="shown">SHOWN<a href="#shown" class="hash-link" aria-label="Direct link to SHOWN" title="Direct link to SHOWN">​</a></h3>
332
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Category Name<td>Category to associate the tool with<td>True</table>
333
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=shown>SHOWN<a href=#shown class=hash-link aria-label="Direct link to SHOWN" title="Direct link to SHOWN">​</a></h3>
326
334
  <p><strong>Show the tool or not</strong></p>
327
335
  <p>Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool.</p>
328
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Shown</td><td>Whether or not the tool is shown. TRUE or FALSE<br><br>Valid Values: <span class="values">true, false</span></td><td>True</td></tr></tbody></table>
329
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="position">POSITION<a href="#position" class="hash-link" aria-label="Direct link to POSITION" title="Direct link to POSITION">​</a></h3>
330
- <p></p><div class="right">(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
336
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Shown<td>Whether or not the tool is shown. TRUE or FALSE<br><br>Valid Values: <span class=values>true, false</span><td>True</table>
337
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=position>POSITION<a href=#position class=hash-link aria-label="Direct link to POSITION" title="Direct link to POSITION">​</a></h3>
338
+ <p><div class=right>(Since 5.0.8)</div><strong>Position of the tool in the nav bar</strong><p></p>
331
339
  <p>Position of the tool starting at 2 (1 is reserved for Admin Console). Tools without a position are appended to the end as they are installed. All COSMOS open source tools have consecutive integer values for position.</p>
332
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Position</td><td>Numerical position</td><td>True</td></tr></tbody></table>
333
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb-2">DISABLE_ERB<a href="#disable_erb-2" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
334
- <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
340
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Position<td>Numerical position<td>True</table>
341
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disable_erb-2>DISABLE_ERB<a href=#disable_erb-2 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
342
+ <p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
335
343
  <p>Disable ERB processing for the entire tool or a set of regular expressions over its filenames</p>
336
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table>
337
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="widget">WIDGET<a href="#widget" class="hash-link" aria-label="Direct link to WIDGET" title="Direct link to WIDGET">​</a></h2>
344
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table>
345
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=import_map_item>IMPORT_MAP_ITEM<a href=#import_map_item class=hash-link aria-label="Direct link to IMPORT_MAP_ITEM" title="Direct link to IMPORT_MAP_ITEM">​</a></h3>
346
+ <p><div class=right>(Since 6.0.0)</div><strong>Add an item to the import map</strong><p></p>
347
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>key<td>Import Map Key<td>True<tr><td>value<td>Import Map Value<td>True</table>
348
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=widget>WIDGET<a href=#widget class=hash-link aria-label="Direct link to WIDGET" title="Direct link to WIDGET">​</a></h2>
338
349
  <p><strong>Define a custom widget</strong></p>
339
350
  <p>Defines a custom widget that can be used in Telemetry Viewer screens.</p>
340
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Widget Name</td><td>The name of the widget will be used to build a path to the widget implementation. For example, <code>WIDGET HELLOWORLD</code> will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the <a href="/tools/staticdocs/docs/guides/custom-widgets">Custom Widgets</a> guide for more details.</td><td>True</td></tr><tr><td>Label</td><td>The label for the widget that will appear in the Data Viewer component drop down</td><td>False</td></tr></tbody></table>
351
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Widget Name<td>The name of the widget will be used to build a path to the widget implementation. For example, <code>WIDGET HELLOWORLD</code> will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the <a href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a> guide for more details.<td>True<tr><td>Label<td>The label for the widget that will appear in the Data Viewer component drop down<td>False</table>
341
352
  <p>Example Usage:</p>
342
- <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)">WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HELLOWORLD</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>
343
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="widget-modifiers">WIDGET Modifiers<a href="#widget-modifiers" class="hash-link" aria-label="Direct link to WIDGET Modifiers" title="Direct link to WIDGET Modifiers">​</a></h2>
353
+ <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)">WIDGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HELLOWORLD</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>
354
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=widget-modifiers>WIDGET Modifiers<a href=#widget-modifiers class=hash-link aria-label="Direct link to WIDGET Modifiers" title="Direct link to WIDGET Modifiers">​</a></h2>
344
355
  <p>The following keywords must follow a WIDGET keyword.</p>
345
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="disable_erb-3">DISABLE_ERB<a href="#disable_erb-3" class="hash-link" aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
346
- <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
356
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=disable_erb-3>DISABLE_ERB<a href=#disable_erb-3 class=hash-link aria-label="Direct link to DISABLE_ERB" title="Direct link to DISABLE_ERB">​</a></h3>
357
+ <p><div class=right>(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
347
358
  <p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
348
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.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/format"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Targets</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
349
- </body>
350
- </html>
359
+ <table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Regex<td>Regex to match against filenames. If match, then no ERB processing<td>False</table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.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/format><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/target><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Targets</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=#introduction class="table-of-contents__link toc-highlight">Introduction</a><li><a href=#concepts class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href=#target class="table-of-contents__link toc-highlight">Target</a><li><a href=#interface class="table-of-contents__link toc-highlight">Interface</a><li><a href=#router class="table-of-contents__link toc-highlight">Router</a><li><a href=#tool class="table-of-contents__link toc-highlight">Tool</a><li><a href=#microservice class="table-of-contents__link toc-highlight">Microservice</a></ul><li><a href=#plugin-directory-structure class="table-of-contents__link toc-highlight">Plugin Directory Structure</a><li><a href=#plugintxt-configuration-file class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a><li><a href=#variable class="table-of-contents__link toc-highlight">VARIABLE</a><li><a href=#needs_dependencies class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a><li><a href=#interface-1 class="table-of-contents__link toc-highlight">INTERFACE</a><li><a href=#interface-modifiers class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href=#map_target class="table-of-contents__link toc-highlight">MAP_TARGET</a><li><a href=#map_cmd_target class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a><li><a href=#map_tlm_target class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a><li><a href=#dont_connect class="table-of-contents__link toc-highlight">DONT_CONNECT</a><li><a href=#dont_reconnect class="table-of-contents__link toc-highlight">DONT_RECONNECT</a><li><a href=#reconnect_delay class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a><li><a href=#disable_disconnect class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a><li><a href=#log_raw class="table-of-contents__link toc-highlight">LOG_RAW</a><li><a href=#log_stream class="table-of-contents__link toc-highlight">LOG_STREAM</a><li><a href=#protocol class="table-of-contents__link toc-highlight">PROTOCOL</a><li><a href=#option class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#secret class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#env class="table-of-contents__link toc-highlight">ENV</a><li><a href=#work_dir class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port class="table-of-contents__link toc-highlight">PORT</a><li><a href=#cmd class="table-of-contents__link toc-highlight">CMD</a><li><a href=#container class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#route_prefix class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#shard class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#router-1 class="table-of-contents__link toc-highlight">ROUTER</a><li><a href=#target-1 class="table-of-contents__link toc-highlight">TARGET</a><li><a href=#target-modifiers class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href=#cmd_buffer_depth class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a><li><a href=#cmd_log_cycle_time class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a><li><a href=#cmd_log_cycle_size class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a><li><a href=#cmd_log_retain_time class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a><li><a href=#cmd_decom_log_cycle_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a><li><a href=#cmd_decom_log_cycle_size class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a><li><a href=#cmd_decom_log_retain_time class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a><li><a href=#tlm_buffer_depth class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a><li><a href=#tlm_log_cycle_time class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a><li><a href=#tlm_log_cycle_size class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a><li><a href=#tlm_log_retain_time class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a><li><a href=#tlm_decom_log_cycle_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a><li><a href=#tlm_decom_log_cycle_size class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a><li><a href=#tlm_decom_log_retain_time class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a><li><a href=#reduced_minute_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a><li><a href=#reduced_hour_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a><li><a href=#reduced_day_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a><li><a href=#log_retain_time class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a><li><a href=#reduced_log_retain_time class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a><li><a href=#cleanup_poll_time class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a><li><a href=#reducer_disable class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a><li><a href=#reducer_max_cpu_utilization class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a><li><a href=#target_microservice class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a><li><a href=#packet class="table-of-contents__link toc-highlight">PACKET</a><li><a href=#disable_erb class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-1 class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#microservice-1 class="table-of-contents__link toc-highlight">MICROSERVICE</a><li><a href=#microservice-modifiers class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href=#env-1 class="table-of-contents__link toc-highlight">ENV</a><li><a href=#work_dir-1 class="table-of-contents__link toc-highlight">WORK_DIR</a><li><a href=#port-1 class="table-of-contents__link toc-highlight">PORT</a><li><a href=#topic class="table-of-contents__link toc-highlight">TOPIC</a><li><a href=#target_name class="table-of-contents__link toc-highlight">TARGET_NAME</a><li><a href=#cmd-1 class="table-of-contents__link toc-highlight">CMD</a><li><a href=#option-1 class="table-of-contents__link toc-highlight">OPTION</a><li><a href=#container-1 class="table-of-contents__link toc-highlight">CONTAINER</a><li><a href=#secret-1 class="table-of-contents__link toc-highlight">SECRET</a><li><a href=#route_prefix-1 class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a><li><a href=#disable_erb-1 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#shard-2 class="table-of-contents__link toc-highlight">SHARD</a></ul><li><a href=#tool-1 class="table-of-contents__link toc-highlight">TOOL</a><li><a href=#tool-modifiers class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href=#url class="table-of-contents__link toc-highlight">URL</a><li><a href=#inline_url class="table-of-contents__link toc-highlight">INLINE_URL</a><li><a href=#window class="table-of-contents__link toc-highlight">WINDOW</a><li><a href=#icon class="table-of-contents__link toc-highlight">ICON</a><li><a href=#category class="table-of-contents__link toc-highlight">CATEGORY</a><li><a href=#shown class="table-of-contents__link toc-highlight">SHOWN</a><li><a href=#position class="table-of-contents__link toc-highlight">POSITION</a><li><a href=#disable_erb-2 class="table-of-contents__link toc-highlight">DISABLE_ERB</a><li><a href=#import_map_item class="table-of-contents__link toc-highlight">IMPORT_MAP_ITEM</a></ul><li><a href=#widget class="table-of-contents__link toc-highlight">WIDGET</a><li><a href=#widget-modifiers class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href=#disable_erb-3 class="table-of-contents__link toc-highlight">DISABLE_ERB</a></ul></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>