openc3-cosmos-tool-docs 6.7.0 → 6.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +1 -1
- data/tools/staticdocs/assets/css/{styles.3a94737c.css → styles.0edf3032.css} +1 -1
- data/tools/staticdocs/assets/images/add_command-46f5156d66ce939d3baf87e565193dc4cd281c11c09cb15e11f3a08fdb750b4a.png +0 -0
- data/tools/staticdocs/assets/images/command_queue-1a7f929500f5b51d87c653b83236b886fa2d348127a986d294813de5c52ff80b.png +0 -0
- data/tools/staticdocs/assets/images/log_explorer-97cc7347dd918410b63fa107ce9fb7c908c1babc4026a96bdea6700137da5e37.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5366d64b.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.eb311155.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.974abc47.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.0727eb1b.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +1 -0
- data/tools/staticdocs/assets/js/10209fc9.ae369363.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.32c30401.js +1 -0
- data/tools/staticdocs/assets/js/1085.d1eba438.js +1 -0
- data/tools/staticdocs/assets/js/1319.d9ec0592.js +101 -0
- data/tools/staticdocs/assets/js/13196248.9e1ebaa5.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.6446ccbc.js +1 -0
- data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.a89f2446.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.0955283c.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.81906212.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +1 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.f43cd057.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.db29df30.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.28293824.js +1 -0
- data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.35825078.js +1 -0
- data/tools/staticdocs/assets/js/5074.653f3924.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.9468b8ed.js +1 -0
- data/tools/staticdocs/assets/js/5410.60ab1dba.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +1 -0
- data/tools/staticdocs/assets/js/{59ed27a4.e9ab6f6b.js → 59ed27a4.8eb3444b.js} +1 -1
- data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +1 -0
- data/tools/staticdocs/assets/js/6242.bdac32c1.js +4 -0
- data/tools/staticdocs/assets/js/{62df909c.dd5f3a0c.js → 62df909c.1abd26b3.js} +1 -1
- data/tools/staticdocs/assets/js/{630e5448.db32449b.js → 630e5448.8195b015.js} +1 -1
- data/tools/staticdocs/assets/js/6831b732.7cf97282.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.b96d263c.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +1 -0
- data/tools/staticdocs/assets/js/75897369.f13aa17b.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +1 -0
- data/tools/staticdocs/assets/js/7f5b2696.e1f3d862.js +1 -0
- data/tools/staticdocs/assets/js/8434.a3e5442b.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +1 -0
- data/tools/staticdocs/assets/js/8851.4837d29a.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.4253acd5.js +1 -0
- data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.791cdc39.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.b9f15524.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.2695e35a.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.71b17b00.js +1 -0
- data/tools/staticdocs/assets/js/{a9b2dc27.b072fff7.js → a9b2dc27.c8eb51b6.js} +1 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.e240f32e.js +1 -0
- data/tools/staticdocs/assets/js/{b38a6d74.9f9ebdb2.js → b38a6d74.7363be85.js} +1 -1
- data/tools/staticdocs/assets/js/b4596165.2a473696.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.2c4823f0.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +1 -0
- data/tools/staticdocs/assets/js/c2598f55.7a2138ca.js +1 -0
- data/tools/staticdocs/assets/js/{c5388ca4.32f8f561.js → c5388ca4.0ddcb653.js} +1 -1
- data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +1 -0
- data/tools/staticdocs/assets/js/{ce89ef36.6b89b0fe.js → ce89ef36.73fcb368.js} +1 -1
- data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +1 -0
- data/tools/staticdocs/assets/js/{d1b923aa.5b892530.js → d1b923aa.482b8f7b.js} +1 -1
- data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +1 -0
- data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.15b70d4b.js +1 -0
- data/tools/staticdocs/assets/js/{dfbae5fd.3959d626.js → dfbae5fd.011fc630.js} +1 -1
- data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +1 -0
- data/tools/staticdocs/assets/js/{f75a5f33.cdf29c46.js → f75a5f33.4d2501bc.js} +1 -1
- data/tools/staticdocs/assets/js/fd886806.f7bfd80c.js +1 -0
- data/tools/staticdocs/assets/js/main.994f9f74.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.44311138.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +1 -1
- data/tools/staticdocs/docs/configuration/command.html +1 -1
- data/tools/staticdocs/docs/configuration/conversions.html +1 -1
- data/tools/staticdocs/docs/configuration/format.html +1 -1
- data/tools/staticdocs/docs/configuration/interfaces.html +3 -3
- data/tools/staticdocs/docs/configuration/limits-response.html +1 -1
- data/tools/staticdocs/docs/configuration/plugins.html +1 -1
- data/tools/staticdocs/docs/configuration/processors.html +1 -1
- data/tools/staticdocs/docs/configuration/protocols.html +3 -3
- data/tools/staticdocs/docs/configuration/ssl-tls.html +1 -1
- data/tools/staticdocs/docs/configuration/table.html +1 -1
- data/tools/staticdocs/docs/configuration/target.html +1 -1
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +1 -1
- data/tools/staticdocs/docs/configuration/telemetry.html +1 -1
- data/tools/staticdocs/docs/configuration.html +1 -1
- data/tools/staticdocs/docs/development/curl.html +1 -1
- data/tools/staticdocs/docs/development/developing.html +1 -1
- data/tools/staticdocs/docs/development/json-api.html +1 -1
- data/tools/staticdocs/docs/development/log-structure.html +1 -1
- data/tools/staticdocs/docs/development/roadmap.html +3 -19
- data/tools/staticdocs/docs/development/streaming-api.html +1 -1
- data/tools/staticdocs/docs/development/testing.html +1 -1
- data/tools/staticdocs/docs/development.html +1 -1
- data/tools/staticdocs/docs/getting-started/cli.html +1 -1
- data/tools/staticdocs/docs/getting-started/generators.html +1 -1
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +1 -1
- data/tools/staticdocs/docs/getting-started/installation.html +1 -1
- data/tools/staticdocs/docs/getting-started/key-concepts.html +1 -1
- data/tools/staticdocs/docs/getting-started/podman.html +1 -1
- data/tools/staticdocs/docs/getting-started/requirements.html +1 -1
- data/tools/staticdocs/docs/getting-started/upgrading.html +3 -2
- data/tools/staticdocs/docs/getting-started.html +1 -1
- data/tools/staticdocs/docs/guides/bridges.html +1 -1
- data/tools/staticdocs/docs/guides/cfs.html +1 -1
- data/tools/staticdocs/docs/guides/custom-widgets.html +9 -2
- data/tools/staticdocs/docs/guides/dynamic-packets.html +1 -1
- data/tools/staticdocs/docs/guides/exposing-microservices.html +1 -1
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +1 -1
- data/tools/staticdocs/docs/guides/local-mode.html +1 -1
- data/tools/staticdocs/docs/guides/logging.html +1 -1
- data/tools/staticdocs/docs/guides/monitoring.html +1 -1
- data/tools/staticdocs/docs/guides/performance.html +1 -1
- data/tools/staticdocs/docs/guides/raspberrypi.html +1 -1
- data/tools/staticdocs/docs/guides/reference-architectures.html +1 -1
- data/tools/staticdocs/docs/guides/script-writing.html +1 -1
- data/tools/staticdocs/docs/guides/scripting-api.html +79 -4
- data/tools/staticdocs/docs/guides/troubleshooting.html +7 -1
- data/tools/staticdocs/docs/guides.html +1 -1
- data/tools/staticdocs/docs/meta/contributing.html +1 -1
- data/tools/staticdocs/docs/meta/licenses.html +1 -1
- data/tools/staticdocs/docs/meta/philosophy.html +1 -1
- data/tools/staticdocs/docs/meta/xtce.html +1 -1
- data/tools/staticdocs/docs/meta.html +1 -1
- data/tools/staticdocs/docs/privacy.html +1 -1
- data/tools/staticdocs/docs/tools/admin.html +2 -2
- data/tools/staticdocs/docs/tools/autonomic.html +2 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +2 -2
- data/tools/staticdocs/docs/tools/calendar.html +2 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +2 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +3 -3
- data/tools/staticdocs/docs/tools/{command_history.html → command-history.html} +3 -3
- data/tools/staticdocs/docs/tools/command-queue.html +22 -0
- data/tools/staticdocs/docs/tools/data-extractor.html +3 -3
- data/tools/staticdocs/docs/tools/data-viewer.html +2 -2
- data/tools/staticdocs/docs/tools/handbooks.html +2 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +3 -3
- data/tools/staticdocs/docs/tools/log-explorer.html +29 -0
- data/tools/staticdocs/docs/tools/packet-viewer.html +3 -3
- data/tools/staticdocs/docs/tools/script-runner.html +2 -2
- data/tools/staticdocs/docs/tools/systemhealth.html +2 -2
- data/tools/staticdocs/docs/tools/table-manager.html +2 -2
- data/tools/staticdocs/docs/tools/tlm-grapher.html +2 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +2 -2
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +1 -1
- data/tools/staticdocs/img/command_queue/add_command.png +0 -0
- data/tools/staticdocs/img/command_queue/command_queue.png +0 -0
- data/tools/staticdocs/img/log_explorer/log_explorer.png +0 -0
- data/tools/staticdocs/index.html +1 -1
- data/tools/staticdocs/lunr-index-1757781681330.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +1 -1
- data/tools/staticdocs/search-doc-1757781681330.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +109 -99
- data/tools/staticdocs/assets/js/019369f3.aee00d57.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.4303e204.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.be701f94.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.e6fc6dd3.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.a79a923a.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.9c143528.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.37e9dfb2.js +0 -1
- data/tools/staticdocs/assets/js/13196248.21d79b91.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.91618ec1.js +0 -1
- data/tools/staticdocs/assets/js/1602.a7ddd3dc.js +0 -1
- data/tools/staticdocs/assets/js/1836.1d45ff5f.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.600ebf22.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.50c117b3.js +0 -1
- data/tools/staticdocs/assets/js/2124.c8b95b39.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.cfbc9c82.js +0 -1
- data/tools/staticdocs/assets/js/2368.071909f8.js +0 -4
- data/tools/staticdocs/assets/js/26b8abb2.021651f5.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.44f29c21.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.d1ffefde.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.431a9dcc.js +0 -1
- data/tools/staticdocs/assets/js/3687.0184c4bd.js +0 -101
- data/tools/staticdocs/assets/js/3dd7ef3b.bd26614f.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.19107461.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.91b73850.js +0 -1
- data/tools/staticdocs/assets/js/42170351.082207e5.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.f076a420.js +0 -1
- data/tools/staticdocs/assets/js/5074.11914a81.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.2da36c11.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.9ad6d6ad.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.085f41a9.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.2b490409.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.1cf87b97.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.92ac2561.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.aa0ccb3b.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.bb545e9e.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.f976483f.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.71cd015b.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.9c1a2ea5.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.acc724a9.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.f72c7c50.js +0 -1
- data/tools/staticdocs/assets/js/75897369.522ccdd7.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.f1731ba5.js +0 -1
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +0 -1
- data/tools/staticdocs/assets/js/7f5b2696.a3dc640e.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.b5528d51.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.a5ebb584.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.6f1bd0e6.js +0 -1
- data/tools/staticdocs/assets/js/8b939c74.bb6669b6.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.56210187.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.4d21b90c.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.7b1d7e91.js +0 -1
- data/tools/staticdocs/assets/js/97535711.ba627d0c.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.f64fd445.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.c58de1b0.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.f48e20dc.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.6178ef83.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.0d275743.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.a3594c17.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.96a0a741.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.8f48aec1.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.16ef1b69.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.df189198.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.005cb7d6.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.052a322f.js +0 -1
- data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.989b1a52.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.3ca90941.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.421b8b4b.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.0670c343.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.2db3594a.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.dd2f0a5d.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.3fe16a67.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.4216f492.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.0bdab1a3.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.3909c726.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.416dbe98.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.da0777f1.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.bc79c9f5.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.732c5ad4.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.6a937fc3.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.833fb1cc.js +0 -1
- data/tools/staticdocs/assets/js/main.8b65f76b.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.ff5e0de8.js +0 -1
- data/tools/staticdocs/lunr-index-1754357604573.json +0 -1
- data/tools/staticdocs/search-doc-1754357604573.json +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/scripting-api" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Scripting API Guide | 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/guides/scripting-api><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Scripting API Guide | OpenC3 Docs"><meta data-rh=true name=description content="Scripting API methods, deprecations and migrations"><meta data-rh=true property=og:description content="Scripting API methods, deprecations and migrations"><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/guides/scripting-api><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api","name":"Scripting API Guide","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.
|
|
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-guides/scripting-api" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Scripting API Guide | 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/guides/scripting-api><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Scripting API Guide | OpenC3 Docs"><meta data-rh=true name=description content="Scripting API methods, deprecations and migrations"><meta data-rh=true property=og:description content="Scripting API methods, deprecations and migrations"><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/guides/scripting-api><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api","name":"Scripting API Guide","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.0edf3032.css><script src=/tools/staticdocs/assets/js/runtime~main.44311138.js defer></script><script src=/tools/staticdocs/assets/js/main.994f9f74.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
4
|
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</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/guides/cfs>COSMOS and NASA cFS</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/guides/custom-widgets>Custom Widgets</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/guides/dynamic-packets>Dynamic Packets</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/guides/exposing-microservices>Exposing Microservices</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/guides/little-endian-bitfields>Little Endian Bitfields</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/guides/local-mode>Local Mode</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/guides/logging>Logging</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/guides/monitoring>Monitoring</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/guides/performance>Performance</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/guides/raspberrypi>Raspberry Pi</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/guides/reference-architectures>Reference Architectures</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/guides/script-writing>Script Writing Guide</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/guides/scripting-api>Scripting API Guide</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/guides/troubleshooting>Troubleshooting</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/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Scripting API Guide</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Scripting API Guide</h1></header><p>This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.</p>
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
<p>The following API methods have been removed from COSMOS v6. Most of the deprecated API methods still remain for backwards compatibility.</p>
|
|
20
20
|
<table><thead><tr><th>Method<th>Tool<th>Status<tbody><tr><td>get_all_target_info<td>Command and Telemetry Server<td>Removed, use get_target_interfaces<tr><td>play_wav_file<td>Script Runner<td>Removed<tr><td>status_bar<td>Script Runner<td>Removed</table>
|
|
21
21
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=migration-from-cosmos-v4-to-v5>Migration from COSMOS v4 to v5<a href=#migration-from-cosmos-v4-to-v5 class=hash-link aria-label="Direct link to Migration from COSMOS v4 to v5" title="Direct link to Migration from COSMOS v4 to v5"></a></h3>
|
|
22
|
-
<p>The following API methods are
|
|
23
|
-
<table><thead><tr><th>Method<th>Tool<th>Status<tbody><tr><td>clear<td>Telemetry Viewer<td>Deprecated, use clear_screen<tr><td>clear_all<td>Telemetry Viewer<td>Deprecated, use clear_all_screens<tr><td>close_local_screens<td>Telemetry Viewer<td>Deprecated, use clear_screen<tr><td>clear_disconnected_targets<td>Script Runner<td>Deprecated<tr><td>cmd_tlm_clear_counters<td>Command and Telemetry Server<td>Deprecated<tr><td>cmd_tlm_reload<td>Command and Telemetry Server<td>Deprecated<tr><td>display<td>Telemetry Viewer<td>Deprecated, use display_screen<tr><td>get_all_packet_logger_info<td>Command and Telemetry Server<td>Deprecated<tr><td>get_all_target_info<td>Command and Telemetry Server<td>Deprecated, use get_target_interfaces<tr><td>get_background_tasks<td>Command and Telemetry Server<td>Deprecated<tr><td>get_all_cmd_info<td>Command and Telemetry Server<td>Deprecated, use get_all_cmds<tr><td>get_all_tlm_info<td>Command and Telemetry Server<td>Deprecated, use get_all_tlm<tr><td>get_cmd_list<td>Command and Telemetry Server<td>Deprecated, use get_all_cmds<tr><td>get_cmd_log_filename<td>Command and Telemetry Server<td>Deprecated<tr><td>get_cmd_param_list<td>Command and Telemetry Server<td>Deprecated, use get_cmd<tr><td>get_cmd_tlm_disconnect<td>Script Runner<td>Deprecated, use $disconnect<tr><td>get_disconnected_targets<td>Script Runner<td>
|
|
22
|
+
<p>The following API methods are deprecated (will not be ported to COSMOS 5):</p>
|
|
23
|
+
<table><thead><tr><th>Method<th>Tool<th>Status<tbody><tr><td>clear<td>Telemetry Viewer<td>Deprecated, use clear_screen<tr><td>clear_all<td>Telemetry Viewer<td>Deprecated, use clear_all_screens<tr><td>close_local_screens<td>Telemetry Viewer<td>Deprecated, use clear_screen<tr><td>clear_disconnected_targets<td>Script Runner<td>Deprecated<tr><td>cmd_tlm_clear_counters<td>Command and Telemetry Server<td>Deprecated<tr><td>cmd_tlm_reload<td>Command and Telemetry Server<td>Deprecated<tr><td>display<td>Telemetry Viewer<td>Deprecated, use display_screen<tr><td>get_all_packet_logger_info<td>Command and Telemetry Server<td>Deprecated<tr><td>get_all_target_info<td>Command and Telemetry Server<td>Deprecated, use get_target_interfaces<tr><td>get_background_tasks<td>Command and Telemetry Server<td>Deprecated<tr><td>get_all_cmd_info<td>Command and Telemetry Server<td>Deprecated, use get_all_cmds<tr><td>get_all_tlm_info<td>Command and Telemetry Server<td>Deprecated, use get_all_tlm<tr><td>get_cmd_list<td>Command and Telemetry Server<td>Deprecated, use get_all_cmds<tr><td>get_cmd_log_filename<td>Command and Telemetry Server<td>Deprecated<tr><td>get_cmd_param_list<td>Command and Telemetry Server<td>Deprecated, use get_cmd<tr><td>get_cmd_tlm_disconnect<td>Script Runner<td>Deprecated, use $disconnect<tr><td>get_disconnected_targets<td>Script Runner<td>Deprecated<tr><td>get_interface_info<td>Command and Telemetry Server<td>Deprecated, use get_interface<tr><td>get_interface_targets<td>Command and Telemetry Server<td>Deprecated<tr><td>get_output_logs_filenames<td>Command and Telemetry Server<td>Deprecated<tr><td>get_packet<td>Command and Telemetry Server<td>Deprecated, use get_packets<tr><td>get_packet_data<td>Command and Telemetry Server<td>Deprecated, use get_packets<tr><td>get_packet_logger_info<td>Command and Telemetry Server<td>Deprecated<tr><td>get_packet_loggers<td>Command and Telemetry Server<td>Deprecated<tr><td>get_replay_mode<td>Replay<td>Deprecated<tr><td>get_router_info<td>Command and Telemetry Server<td>Deprecated, use get_router<tr><td>get_scriptrunner_message_log_filename<td>Command and Telemetry Server<td>Deprecated<tr><td>get_server_message<td>Command and Telemetry Server<td>Deprecated<tr><td>get_server_message_log_filename<td>Command and Telemetry Server<td>Deprecated<tr><td>get_server_status<td>Command and Telemetry Server<td>Deprecated<tr><td>get_stale<td>Command and Telemetry Server<td>Deprecated<tr><td>get_target_ignored_items<td>Command and Telemetry Server<td>Deprecated, use get_target<tr><td>get_target_ignored_parameters<td>Command and Telemetry Server<td>Deprecated, use get_target<tr><td>get_target_info<td>Command and Telemetry Server<td>Deprecated, use get_target<tr><td>get_target_list<td>Command and Telemetry Server<td>Deprecated, use get_target_names<tr><td>get_tlm_details<td>Command and Telemetry Server<td>Deprecated<tr><td>get_tlm_item_list<td>Command and Telemetry Server<td>Deprecated<tr><td>get_tlm_list<td>Command and Telemetry Server<td>Deprecated<tr><td>get_tlm_log_filename<td>Command and Telemetry Server<td>Deprecated<tr><td>interface_state<td>Command and Telemetry Server<td>Deprecated, use get_interface<tr><td>override_tlm_raw<td>Command and Telemetry Server<td>Deprecated, use override_tlm<tr><td>open_directory_dialog<td>Script Runner<td>Deprecated<tr><td>play_wav_file<td>Script Runner<td>Deprecated<tr><td>replay_move_end<td>Replay<td>Deprecated<tr><td>replay_move_index<td>Replay<td>Deprecated<tr><td>replay_move_start<td>Replay<td>Deprecated<tr><td>replay_play<td>Replay<td>Deprecated<tr><td>replay_reverse_play<td>Replay<td>Deprecated<tr><td>replay_select_file<td>Replay<td>Deprecated<tr><td>replay_set_playback_delay<td>Replay<td>Deprecated<tr><td>replay_status<td>Replay<td>Deprecated<tr><td>replay_step_back<td>Replay<td>Deprecated<tr><td>replay_step_forward<td>Replay<td>Deprecated<tr><td>replay_stop<td>Replay<td>Deprecated<tr><td>require_utility<td>Script Runner<td>Deprecated but exists for backwards compatibility, use load_utility<tr><td>router_state<td>Command and Telemetry Server<td>Deprecated, use get_router<tr><td>save_file_dialog<td>Script Runner<td>Deprecated<tr><td>save_setting<td>Command and Telemetry Server<td>Deprecated but exists for backwards compatibility, use set_setting<tr><td>set_cmd_tlm_disconnect<td>Script Runner<td>Deprecated, use disconnect_script<tr><td>set_disconnected_targets<td>Script Runner<td>Deprecated<tr><td>set_replay_mode<td>Replay<td>Deprecated<tr><td>set_stdout_max_lines<td>Script Runner<td>Deprecated<tr><td>set_tlm_raw<td>Script Runner<td>Deprecated, use set_tlm<tr><td>show_backtrace<td>Script Runner<td>Deprecated, backtrace always shown<tr><td>status_bar<td>Script Runner<td>Deprecated<tr><td>shutdown_cmd_tlm<td>Command and Telemetry Server<td>Deprecated<tr><td>start_cmd_log<td>Command and Telemetry Server<td>Deprecated<tr><td>start_logging<td>Command and Telemetry Server<td>Deprecated<tr><td>start_new_scriptrunner_message_log<td>Command and Telemetry Server<td>Deprecated<tr><td>start_new_server_message_log<td>Command and Telemetry Server<td>Deprecated<tr><td>start_tlm_log<td>Command and Telemetry Server<td>Deprecated<tr><td>stop_background_task<td>Command and Telemetry Server<td>Deprecated<tr><td>stop_cmd_log<td>Command and Telemetry Server<td>Deprecated<tr><td>stop_logging<td>Command and Telemetry Server<td>Deprecated<tr><td>stop_tlm_log<td>Command and Telemetry Server<td>Deprecated<tr><td>subscribe_limits_events<td>Command and Telemetry Server<td>Deprecated<tr><td>subscribe_packet_data<td>Command and Telemetry Server<td>Deprecated, use subscribe_packets<tr><td>subscribe_server_messages<td>Command and Telemetry Server<td>Deprecated<tr><td>tlm_variable<td>Script Runner<td>Deprecated, use tlm() and pass type<tr><td>unsubscribe_limits_events<td>Command and Telemetry Server<td>Deprecated<tr><td>unsubscribe_packet_data<td>Command and Telemetry Server<td>Deprecated<tr><td>unsubscribe_server_messages<td>Command and Telemetry Server<td>Deprecated<tr><td>wait_raw<td>Script Runner<td>Deprecated, use wait(..., type: <!-- -->:RAW<!-- -->)<tr><td>wait_check_raw<td>Script Runner<td>Deprecated, use wait_check(..., type: <!-- -->:RAW<!-- -->)<tr><td>wait_tolerance_raw<td>Script Runner<td>Deprecated, use wait_tolerance(..., type: <!-- -->:RAW<!-- -->)<tr><td>wait_check_tolerance_raw<td>Script Runner<td>Deprecated, use wait_check_tolerance(..., type: <!-- -->:RAW<!-- -->)</table>
|
|
24
24
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=retrieving-user-input>Retrieving User Input<a href=#retrieving-user-input class=hash-link aria-label="Direct link to Retrieving User Input" title="Direct link to Retrieving User Input"></a></h2>
|
|
25
25
|
<p>These methods allow the user to enter values that are needed by the script.</p>
|
|
26
26
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ask>ask<a href=#ask class=hash-link aria-label="Direct link to ask" title="Direct link to ask"></a></h3>
|
|
@@ -234,6 +234,81 @@
|
|
|
234
234
|
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">critical_cmd_can_approve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">uuid</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">critical_cmd_can_approve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">uuid</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
235
235
|
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>uuid<td>UUID for the critical command (displayed in the COSMOS GUI)</table>
|
|
236
236
|
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">status </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> critical_cmd_can_approve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"2fa14183-3148-4399-9a74-a130257118f9"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> true / false</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">status </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> critical_cmd_can_approve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"2fa14183-3148-4399-9a74-a130257118f9"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=> True / False</span><br></span></code></pre></div></div></div></div></div>
|
|
237
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=command-queues>Command Queues<a href=#command-queues class=hash-link aria-label="Direct link to Command Queues" title="Direct link to Command Queues"></a></h2>
|
|
238
|
+
<p>Command queues can be used to store commands prior to "releasing" them for execution. Commands are sent to queues via the <code>queue</code> keyword argument to the various <code>cmd</code> API calls. Queues can be in three different states: <code>HOLD</code>, <code>RELEASE</code>, and <code>DISABLE</code>. <code>HOLD</code> builds up a FIFO of commands as they are generated. <code>RELEASE</code> sends the commands to the interface for execution. <code>DISABLE</code> rejects all commands that are sent via the <code>cmd</code> API calls. Sending a command while a queue is in the <code>DISABLE</code> state will raise an exception and stop the script.</p>
|
|
239
|
+
<p>By setting the environment variable <code>OPENC3_DEFAULT_QUEUE</code> in the .env file you can create a "default" queue that all commands will go to unless explicitly excluded by passing <code>false/False</code> to the <code>queue</code> keyword argument. This queue is created during COSMOS initialization and is created in <code>RELEASE</code> mode so normal commanding will still work. Note that this will introduce delay in the command chain because all commands will flow through the queue instead of being directly executed by the interface.</p>
|
|
240
|
+
<p>Here is an example of sending a command to a queue:</p>
|
|
241
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST ABORT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token symbol">queue</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"TEST"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Do NOT queue the command (useful if OPENC3_DEFAULT_QUEUE is set)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"INST ABORT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token symbol">queue</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST ABORT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> queue</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token string" style="color:rgb(173, 219, 103)">"TEST"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Do NOT queue the command (useful if OPENC3_DEFAULT_QUEUE is set)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">cmd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"INST ABORT"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> queue</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">False</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
242
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_create>queue_create<a href=#queue_create class=hash-link aria-label="Direct link to queue_create" title="Direct link to queue_create"></a></h3>
|
|
243
|
+
<p>Create a command queue. Queues are initially created in HOLD state.</p>
|
|
244
|
+
<blockquote>
|
|
245
|
+
<p>Since 6.8.0</p>
|
|
246
|
+
</blockquote>
|
|
247
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_create</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_create</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
248
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
249
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_create</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_create</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
250
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_get>queue_get<a href=#queue_get class=hash-link aria-label="Direct link to queue_get" title="Direct link to queue_get"></a></h3>
|
|
251
|
+
<p>Get information about a command queue including what state it is in.</p>
|
|
252
|
+
<blockquote>
|
|
253
|
+
<p>Since 6.8.0</p>
|
|
254
|
+
</blockquote>
|
|
255
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_get</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_get</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
256
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
257
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_get</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">puts queue </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_get</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">print</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">queue</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div></div></div>
|
|
258
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_all>queue_all<a href=#queue_all class=hash-link aria-label="Direct link to queue_all" title="Direct link to queue_all"></a></h3>
|
|
259
|
+
<p>Get information about all command queues.</p>
|
|
260
|
+
<blockquote>
|
|
261
|
+
<p>Since 6.8.0</p>
|
|
262
|
+
</blockquote>
|
|
263
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">all </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_all</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">puts all </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token builtin" style="color:rgb(130, 170, 255)">all</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_all</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">print</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token builtin" style="color:rgb(130, 170, 255)">all</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div></div></div>
|
|
264
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_list>queue_list<a href=#queue_list class=hash-link aria-label="Direct link to queue_list" title="Direct link to queue_list"></a></h3>
|
|
265
|
+
<p>List all the commands in the queue including the username, the creation time, and the command itself.</p>
|
|
266
|
+
<blockquote>
|
|
267
|
+
<p>Since 6.8.0</p>
|
|
268
|
+
</blockquote>
|
|
269
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_list</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_list</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
270
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
271
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">cmds </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_list</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">puts cmds </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">cmds </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> queue_list</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">print</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">cmds</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">#=></span><br></span></code></pre></div></div></div></div></div>
|
|
272
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_hold>queue_hold<a href=#queue_hold class=hash-link aria-label="Direct link to queue_hold" title="Direct link to queue_hold"></a></h3>
|
|
273
|
+
<p>Puts the specified queue into HOLD mode which means that commands are queued up and not released to the interface.</p>
|
|
274
|
+
<blockquote>
|
|
275
|
+
<p>Since 6.8.0</p>
|
|
276
|
+
</blockquote>
|
|
277
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_hold</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_hold</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
278
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
279
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_hold</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_hold</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
280
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_release>queue_release<a href=#queue_release class=hash-link aria-label="Direct link to queue_release" title="Direct link to queue_release"></a></h3>
|
|
281
|
+
<p>Puts the specified queue into RELEASE mode which means that commands in the queue are released to the interface. Any new commands added to the queue are immediately released to the interface.</p>
|
|
282
|
+
<blockquote>
|
|
283
|
+
<p>Since 6.8.0</p>
|
|
284
|
+
</blockquote>
|
|
285
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_release</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_release</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
286
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
287
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_release</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_release</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
288
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_disable>queue_disable<a href=#queue_disable class=hash-link aria-label="Direct link to queue_disable" title="Direct link to queue_disable"></a></h3>
|
|
289
|
+
<p>Puts the specified queue into DISABLE mode which means that commands are rejected and not added to the queue. Commands added to a queue in DISABLE mode via script will raise an exception and stop.</p>
|
|
290
|
+
<blockquote>
|
|
291
|
+
<p>Since 6.8.0</p>
|
|
292
|
+
</blockquote>
|
|
293
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_disable</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_disable</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
294
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
295
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_disable</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_disable</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
296
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_exec>queue_exec<a href=#queue_exec class=hash-link aria-label="Direct link to queue_exec" title="Direct link to queue_exec"></a></h3>
|
|
297
|
+
<p>Removes a command from the queue and executes it.</p>
|
|
298
|
+
<blockquote>
|
|
299
|
+
<p>Since 6.8.0</p>
|
|
300
|
+
</blockquote>
|
|
301
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Optional Index>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'<Optional Index>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
302
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue<tr><td>Index<td>Remove and execute at the specified index. If the index is not given the first command is removed and executed.</table>
|
|
303
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Removes and executes the first command in the queue</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token symbol">index</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Removes and executes the first command in the queue</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">queue_exec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> index</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
304
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=queue_delete>queue_delete<a href=#queue_delete class=hash-link aria-label="Direct link to queue_delete" title="Direct link to queue_delete"></a></h3>
|
|
305
|
+
<p>Deletes the specified queue and any commands that it holds.</p>
|
|
306
|
+
<blockquote>
|
|
307
|
+
<p>Since 6.8.0</p>
|
|
308
|
+
</blockquote>
|
|
309
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_delete</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_delete</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'<Queue Name>'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
310
|
+
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>Queue Name<td>Case sensitive name of the queue</table>
|
|
311
|
+
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_delete</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">queue_delete</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'TEST'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
237
312
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=handling-telemetry>Handling Telemetry<a href=#handling-telemetry class=hash-link aria-label="Direct link to Handling Telemetry" title="Direct link to Handling Telemetry"></a></h2>
|
|
238
313
|
<p>These methods allow the user to interact with telemetry items.</p>
|
|
239
314
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=check-check_raw-check_formatted-check_with_units>check, check_raw, check_formatted, check_with_units<a href=#check-check_raw-check_formatted-check_with_units class=hash-link aria-label="Direct link to check, check_raw, check_formatted, check_with_units" title="Direct link to check, check_raw, check_formatted, check_with_units"></a></h3>
|
|
@@ -1084,4 +1159,4 @@ setting of the offline_access_token.</p>
|
|
|
1084
1159
|
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Syntax<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Syntax</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">autonomic_reaction_destroy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token symbol">scope</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">$openc3_scope</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">autonomic_reaction_destroy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> scope</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token boolean" style="color:rgb(255, 88, 116)">None</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
1085
1160
|
<table><thead><tr><th>Parameter<th>Description<tbody><tr><td>name<td>Name of the reaction to destroy<tr><td>scope<td>Scope to operate in (optional)</table>
|
|
1086
1161
|
<div class="tabs-container tabList_M0Dn"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_ysIP tabs__item--active">Ruby Example<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_ysIP">Python Example</ul><div class=margin-top--md><div role=tabpanel class=tabItem_OMyP><div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">autonomic_reaction_destroy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"REACT1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div><div role=tabpanel class=tabItem_OMyP hidden><div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">autonomic_reaction_destroy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">"REACT1"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre></div></div></div></div></div>
|
|
1087
|
-
<pre tabindex=0 class="codeBlockStandalone_K9VJ thin-scrollbar codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><code class=codeBlockLines_AdAo></code></pre></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/guides/scripting-api.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/script-writing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/troubleshooting><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Troubleshooting</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=#concepts class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href=#programming-languages class="table-of-contents__link toc-highlight">Programming Languages</a><li><a href=#using-script-runner class="table-of-contents__link toc-highlight">Using Script Runner</a><li><a href=#telemetry-types class="table-of-contents__link toc-highlight">Telemetry Types</a></ul><li><a href=#script-runner-api class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href=#migration-from-cosmos-v5-to-v6 class="table-of-contents__link toc-highlight">Migration from COSMOS v5 to v6</a><li><a href=#migration-from-cosmos-v4-to-v5 class="table-of-contents__link toc-highlight">Migration from COSMOS v4 to v5</a></ul><li><a href=#retrieving-user-input class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href=#ask class="table-of-contents__link toc-highlight">ask</a><li><a href=#ask_string class="table-of-contents__link toc-highlight">ask_string</a><li><a href=#message_box class="table-of-contents__link toc-highlight">message_box</a><li><a href=#vertical_message_box class="table-of-contents__link toc-highlight">vertical_message_box</a><li><a href=#combo_box class="table-of-contents__link toc-highlight">combo_box</a><li><a href=#get_target_file class="table-of-contents__link toc-highlight">get_target_file</a><li><a href=#put_target_file class="table-of-contents__link toc-highlight">put_target_file</a><li><a href=#delete_target_file class="table-of-contents__link toc-highlight">delete_target_file</a><li><a href=#open_file_dialog class="table-of-contents__link toc-highlight">open_file_dialog</a><li><a href=#open_files_dialog class="table-of-contents__link toc-highlight">open_files_dialog</a></ul><li><a href=#providing-information-to-the-user class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href=#prompt class="table-of-contents__link toc-highlight">prompt</a></ul><li><a href=#commands class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href=#cmd class="table-of-contents__link toc-highlight">cmd</a><li><a href=#cmd_no_range_check class="table-of-contents__link toc-highlight">cmd_no_range_check</a><li><a href=#cmd_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a><li><a href=#cmd_no_checks class="table-of-contents__link toc-highlight">cmd_no_checks</a><li><a href=#cmd_raw class="table-of-contents__link toc-highlight">cmd_raw</a><li><a href=#cmd_raw_no_range_check class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a><li><a href=#cmd_raw_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a><li><a href=#cmd_raw_no_checks class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a><li><a href=#build_cmd class="table-of-contents__link toc-highlight">build_cmd</a><li><a href=#enable_cmd class="table-of-contents__link toc-highlight">enable_cmd</a><li><a href=#disable_cmd class="table-of-contents__link toc-highlight">disable_cmd</a><li><a href=#send_raw class="table-of-contents__link toc-highlight">send_raw</a><li><a href=#get_all_cmds class="table-of-contents__link toc-highlight">get_all_cmds</a><li><a href=#get_all_cmd_names class="table-of-contents__link toc-highlight">get_all_cmd_names</a><li><a href=#get_cmd class="table-of-contents__link toc-highlight">get_cmd</a><li><a href=#get_param class="table-of-contents__link toc-highlight">get_param</a><li><a href=#get_cmd_buffer class="table-of-contents__link toc-highlight">get_cmd_buffer</a><li><a href=#get_cmd_hazardous class="table-of-contents__link toc-highlight">get_cmd_hazardous</a><li><a href=#get_cmd_value class="table-of-contents__link toc-highlight">get_cmd_value</a><li><a href=#get_cmd_time class="table-of-contents__link toc-highlight">get_cmd_time</a><li><a href=#get_cmd_cnt class="table-of-contents__link toc-highlight">get_cmd_cnt</a><li><a href=#get_cmd_cnts class="table-of-contents__link toc-highlight">get_cmd_cnts</a><li><a href=#critical_cmd_status class="table-of-contents__link toc-highlight">critical_cmd_status</a><li><a href=#critical_cmd_approve class="table-of-contents__link toc-highlight">critical_cmd_approve</a><li><a href=#critical_cmd_reject class="table-of-contents__link toc-highlight">critical_cmd_reject</a><li><a href=#critical_cmd_can_approve class="table-of-contents__link toc-highlight">critical_cmd_can_approve</a></ul><li><a href=#handling-telemetry class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href=#check-check_raw-check_formatted-check_with_units class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a><li><a href=#check_tolerance class="table-of-contents__link toc-highlight">check_tolerance</a><li><a href=#check_expression class="table-of-contents__link toc-highlight">check_expression</a><li><a href=#check_exception class="table-of-contents__link toc-highlight">check_exception</a><li><a href=#tlm-tlm_raw-tlm_formatted-tlm_with_units class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a><li><a href=#get_tlm_buffer class="table-of-contents__link toc-highlight">get_tlm_buffer</a><li><a href=#get_tlm_packet class="table-of-contents__link toc-highlight">get_tlm_packet</a><li><a href=#get_tlm_available class="table-of-contents__link toc-highlight">get_tlm_available</a><li><a href=#get_tlm_values class="table-of-contents__link toc-highlight">get_tlm_values</a><li><a href=#get_all_tlm class="table-of-contents__link toc-highlight">get_all_tlm</a><li><a href=#get_all_tlm_names class="table-of-contents__link toc-highlight">get_all_tlm_names</a><li><a href=#get_all_tlm_item_names class="table-of-contents__link toc-highlight">get_all_tlm_item_names</a><li><a href=#get_tlm class="table-of-contents__link toc-highlight">get_tlm</a><li><a href=#get_item class="table-of-contents__link toc-highlight">get_item</a><li><a href=#get_tlm_cnt class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#set_tlm class="table-of-contents__link toc-highlight">set_tlm</a><li><a href=#inject_tlm class="table-of-contents__link toc-highlight">inject_tlm</a><li><a href=#override_tlm class="table-of-contents__link toc-highlight">override_tlm</a><li><a href=#normalize_tlm class="table-of-contents__link toc-highlight">normalize_tlm</a><li><a href=#get_overrides class="table-of-contents__link toc-highlight">get_overrides</a></ul><li><a href=#packet-data-subscriptions class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href=#subscribe_packets class="table-of-contents__link toc-highlight">subscribe_packets</a><li><a href=#get_packets class="table-of-contents__link toc-highlight">get_packets</a><li><a href=#get_tlm_cnt-1 class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#get_tlm_cnts class="table-of-contents__link toc-highlight">get_tlm_cnts</a><li><a href=#get_packet_derived_items class="table-of-contents__link toc-highlight">get_packet_derived_items</a></ul><li><a href=#delays class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href=#wait class="table-of-contents__link toc-highlight">wait</a><li><a href=#wait_tolerance class="table-of-contents__link toc-highlight">wait_tolerance</a><li><a href=#wait_expression class="table-of-contents__link toc-highlight">wait_expression</a><li><a href=#wait_packet class="table-of-contents__link toc-highlight">wait_packet</a><li><a href=#wait_check class="table-of-contents__link toc-highlight">wait_check</a><li><a href=#wait_check_tolerance class="table-of-contents__link toc-highlight">wait_check_tolerance</a><li><a href=#wait_check_expression class="table-of-contents__link toc-highlight">wait_check_expression</a><li><a href=#wait_check_packet class="table-of-contents__link toc-highlight">wait_check_packet</a></ul><li><a href=#limits class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href=#limits_enabled-limits_enabled class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a><li><a href=#enable_limits class="table-of-contents__link toc-highlight">enable_limits</a><li><a href=#disable_limits class="table-of-contents__link toc-highlight">disable_limits</a><li><a href=#enable_limits_group class="table-of-contents__link toc-highlight">enable_limits_group</a><li><a href=#disable_limits_group class="table-of-contents__link toc-highlight">disable_limits_group</a><li><a href=#get_limits_groups class="table-of-contents__link toc-highlight">get_limits_groups</a><li><a href=#set_limits_set class="table-of-contents__link toc-highlight">set_limits_set</a><li><a href=#get_limits_set class="table-of-contents__link toc-highlight">get_limits_set</a><li><a href=#get_limits_sets class="table-of-contents__link toc-highlight">get_limits_sets</a><li><a href=#get_limits class="table-of-contents__link toc-highlight">get_limits</a><li><a href=#set_limits class="table-of-contents__link toc-highlight">set_limits</a><li><a href=#get_out_of_limits class="table-of-contents__link toc-highlight">get_out_of_limits</a><li><a href=#get_overall_limits_state class="table-of-contents__link toc-highlight">get_overall_limits_state</a><li><a href=#get_limits_events class="table-of-contents__link toc-highlight">get_limits_events</a></ul><li><a href=#plugins--packages class="table-of-contents__link toc-highlight">Plugins / Packages</a><ul><li><a href=#plugin_list class="table-of-contents__link toc-highlight">plugin_list</a><li><a href=#plugin_get class="table-of-contents__link toc-highlight">plugin_get</a><li><a href=#package_list class="table-of-contents__link toc-highlight">package_list</a></ul><li><a href=#targets class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href=#get_target_names class="table-of-contents__link toc-highlight">get_target_names</a><li><a href=#get_target class="table-of-contents__link toc-highlight">get_target</a><li><a href=#get_target_interfaces class="table-of-contents__link toc-highlight">get_target_interfaces</a></ul><li><a href=#interfaces class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href=#get_interface class="table-of-contents__link toc-highlight">get_interface</a><li><a href=#get_interface_names class="table-of-contents__link toc-highlight">get_interface_names</a><li><a href=#connect_interface class="table-of-contents__link toc-highlight">connect_interface</a><li><a href=#disconnect_interface class="table-of-contents__link toc-highlight">disconnect_interface</a><li><a href=#start_raw_logging_interface class="table-of-contents__link toc-highlight">start_raw_logging_interface</a><li><a href=#stop_raw_logging_interface class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a><li><a href=#get_all_interface_info class="table-of-contents__link toc-highlight">get_all_interface_info</a><li><a href=#map_target_to_interface class="table-of-contents__link toc-highlight">map_target_to_interface</a><li><a href=#interface_cmd class="table-of-contents__link toc-highlight">interface_cmd</a><li><a href=#interface_protocol_cmd class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></ul><li><a href=#routers class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href=#connect_router class="table-of-contents__link toc-highlight">connect_router</a><li><a href=#disconnect_router class="table-of-contents__link toc-highlight">disconnect_router</a><li><a href=#get_router_names class="table-of-contents__link toc-highlight">get_router_names</a><li><a href=#get_router class="table-of-contents__link toc-highlight">get_router</a><li><a href=#get_all_router_info class="table-of-contents__link toc-highlight">get_all_router_info</a><li><a href=#start_raw_logging_router class="table-of-contents__link toc-highlight">start_raw_logging_router</a><li><a href=#stop_raw_logging_router class="table-of-contents__link toc-highlight">stop_raw_logging_router</a><li><a href=#router_cmd class="table-of-contents__link toc-highlight">router_cmd</a><li><a href=#router_protocol_cmd class="table-of-contents__link toc-highlight">router_protocol_cmd</a></ul><li><a href=#tables class="table-of-contents__link toc-highlight">Tables</a><ul><li><a href=#table_create_binary class="table-of-contents__link toc-highlight">table_create_binary</a><li><a href=#table_create_report class="table-of-contents__link toc-highlight">table_create_report</a></ul><li><a href=#stashing-data class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href=#stash_set class="table-of-contents__link toc-highlight">stash_set</a><li><a href=#stash_get class="table-of-contents__link toc-highlight">stash_get</a><li><a href=#stash_all class="table-of-contents__link toc-highlight">stash_all</a><li><a href=#stash_keys class="table-of-contents__link toc-highlight">stash_keys</a><li><a href=#stash_delete class="table-of-contents__link toc-highlight">stash_delete</a></ul><li><a href=#telemetry-screens class="table-of-contents__link toc-highlight">Telemetry Screens</a><ul><li><a href=#display_screen class="table-of-contents__link toc-highlight">display_screen</a><li><a href=#clear_screen class="table-of-contents__link toc-highlight">clear_screen</a><li><a href=#clear_all_screens class="table-of-contents__link toc-highlight">clear_all_screens</a><li><a href=#delete_screen class="table-of-contents__link toc-highlight">delete_screen</a><li><a href=#get_screen_list class="table-of-contents__link toc-highlight">get_screen_list</a><li><a href=#get_screen_definition class="table-of-contents__link toc-highlight">get_screen_definition</a><li><a href=#create_screen class="table-of-contents__link toc-highlight">create_screen</a><li><a href=#local_screen class="table-of-contents__link toc-highlight">local_screen</a></ul><li><a href=#script-runner-scripts class="table-of-contents__link toc-highlight">Script Runner Scripts</a><ul><li><a href=#start class="table-of-contents__link toc-highlight">start</a><li><a href=#goto class="table-of-contents__link toc-highlight">goto</a><li><a href=#load_utility class="table-of-contents__link toc-highlight">load_utility</a><li><a href=#script_list class="table-of-contents__link toc-highlight">script_list</a><li><a href=#script_create class="table-of-contents__link toc-highlight">script_create</a><li><a href=#script_body class="table-of-contents__link toc-highlight">script_body</a><li><a href=#script_delete class="table-of-contents__link toc-highlight">script_delete</a><li><a href=#script_run class="table-of-contents__link toc-highlight">script_run</a><li><a href=#script_lock class="table-of-contents__link toc-highlight">script_lock</a><li><a href=#script_unlock class="table-of-contents__link toc-highlight">script_unlock</a><li><a href=#script_syntax_check class="table-of-contents__link toc-highlight">script_syntax_check</a><li><a href=#script_instrumented class="table-of-contents__link toc-highlight">script_instrumented</a><li><a href=#script_delete_all_breakpoints class="table-of-contents__link toc-highlight">script_delete_all_breakpoints</a><li><a href=#step_mode class="table-of-contents__link toc-highlight">step_mode</a><li><a href=#run_mode class="table-of-contents__link toc-highlight">run_mode</a><li><a href=#disconnect_script class="table-of-contents__link toc-highlight">disconnect_script</a><li><a href=#running_script_list class="table-of-contents__link toc-highlight">running_script_list</a><li><a href=#script_get class="table-of-contents__link toc-highlight">script_get</a><li><a href=#running_script_stop class="table-of-contents__link toc-highlight">running_script_stop</a><li><a href=#running_script_pause class="table-of-contents__link toc-highlight">running_script_pause</a><li><a href=#running_script_retry class="table-of-contents__link toc-highlight">running_script_retry</a><li><a href=#running_script_go class="table-of-contents__link toc-highlight">running_script_go</a><li><a href=#running_script_execute_while_paused class="table-of-contents__link toc-highlight">running_script_execute_while_paused</a><li><a href=#running_script_step class="table-of-contents__link toc-highlight">running_script_step</a><li><a href=#running_script_delete class="table-of-contents__link toc-highlight">running_script_delete</a><li><a href=#completed_script_list class="table-of-contents__link toc-highlight">completed_script_list</a></ul><li><a href=#script-runner-settings class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href=#set_line_delay class="table-of-contents__link toc-highlight">set_line_delay</a><li><a href=#get_line_delay class="table-of-contents__link toc-highlight">get_line_delay</a><li><a href=#set_max_output class="table-of-contents__link toc-highlight">set_max_output</a><li><a href=#get_max_output class="table-of-contents__link toc-highlight">get_max_output</a><li><a href=#disable_instrumentation class="table-of-contents__link toc-highlight">disable_instrumentation</a></ul><li><a href=#script-runner-suites class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href=#add_group-add_group_setup-add_group_teardown-add_script class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></ul><li><a href=#timelines class="table-of-contents__link toc-highlight">Timelines</a><ul><li><a href=#list_timelines class="table-of-contents__link toc-highlight">list_timelines</a><li><a href=#create_timeline class="table-of-contents__link toc-highlight">create_timeline</a><li><a href=#get_timeline class="table-of-contents__link toc-highlight">get_timeline</a><li><a href=#set_timeline_color class="table-of-contents__link toc-highlight">set_timeline_color</a><li><a href=#delete_timeline class="table-of-contents__link toc-highlight">delete_timeline</a><li><a href=#create_timeline_activity class="table-of-contents__link toc-highlight">create_timeline_activity</a><li><a href=#get_timeline_activity class="table-of-contents__link toc-highlight">get_timeline_activity</a><li><a href=#get_timeline_activities class="table-of-contents__link toc-highlight">get_timeline_activities</a><li><a href=#delete_timeline_activity class="table-of-contents__link toc-highlight">delete_timeline_activity</a></ul><li><a href=#metadata class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href=#metadata_all class="table-of-contents__link toc-highlight">metadata_all</a><li><a href=#metadata_get class="table-of-contents__link toc-highlight">metadata_get</a><li><a href=#metadata_set class="table-of-contents__link toc-highlight">metadata_set</a><li><a href=#metadata_update class="table-of-contents__link toc-highlight">metadata_update</a><li><a href=#metadata_input class="table-of-contents__link toc-highlight">metadata_input</a></ul><li><a href=#settings class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href=#list_settings class="table-of-contents__link toc-highlight">list_settings</a><li><a href=#get_all_settings class="table-of-contents__link toc-highlight">get_all_settings</a><li><a href=#get_setting-get_settings class="table-of-contents__link toc-highlight">get_setting, get_settings</a><li><a href=#set_setting class="table-of-contents__link toc-highlight">set_setting</a></ul><li><a href=#configuration class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href=#config_tool_names class="table-of-contents__link toc-highlight">config_tool_names</a><li><a href=#list_configs class="table-of-contents__link toc-highlight">list_configs</a><li><a href=#load_config class="table-of-contents__link toc-highlight">load_config</a><li><a href=#save_config class="table-of-contents__link toc-highlight">save_config</a><li><a href=#delete_config class="table-of-contents__link toc-highlight">delete_config</a></ul><li><a href=#offline-access class="table-of-contents__link toc-highlight">Offline Access</a><ul><li><a href=#initialize_offline_access class="table-of-contents__link toc-highlight">initialize_offline_access</a><li><a href=#offline_access_needed class="table-of-contents__link toc-highlight">offline_access_needed</a><li><a href=#set_offline_access class="table-of-contents__link toc-highlight">set_offline_access</a></ul><li><a href=#autonomic class="table-of-contents__link toc-highlight">Autonomic</a><ul><li><a href=#autonomic_group_list class="table-of-contents__link toc-highlight">autonomic_group_list</a><li><a href=#autonomic_group_create class="table-of-contents__link toc-highlight">autonomic_group_create</a><li><a href=#autonomic_group_show class="table-of-contents__link toc-highlight">autonomic_group_show</a><li><a href=#autonomic_group_destroy class="table-of-contents__link toc-highlight">autonomic_group_destroy</a><li><a href=#autonomic_trigger_list class="table-of-contents__link toc-highlight">autonomic_trigger_list</a><li><a href=#autonomic_trigger_create class="table-of-contents__link toc-highlight">autonomic_trigger_create</a><li><a href=#autonomic_trigger_show class="table-of-contents__link toc-highlight">autonomic_trigger_show</a><li><a href=#autonomic_trigger_enable class="table-of-contents__link toc-highlight">autonomic_trigger_enable</a><li><a href=#autonomic_trigger_disable class="table-of-contents__link toc-highlight">autonomic_trigger_disable</a><li><a href=#autonomic_trigger_update class="table-of-contents__link toc-highlight">autonomic_trigger_update</a><li><a href=#autonomic_trigger_destroy class="table-of-contents__link toc-highlight">autonomic_trigger_destroy</a><li><a href=#autonomic_reaction_list class="table-of-contents__link toc-highlight">autonomic_reaction_list</a><li><a href=#autonomic_reaction_create class="table-of-contents__link toc-highlight">autonomic_reaction_create</a><li><a href=#autonomic_reaction_show class="table-of-contents__link toc-highlight">autonomic_reaction_show</a><li><a href=#autonomic_reaction_enable class="table-of-contents__link toc-highlight">autonomic_reaction_enable</a><li><a href=#autonomic_reaction_disable class="table-of-contents__link toc-highlight">autonomic_reaction_disable</a><li><a href=#autonomic_reaction_execute class="table-of-contents__link toc-highlight">autonomic_reaction_execute</a><li><a href=#autonomic_reaction_update class="table-of-contents__link toc-highlight">autonomic_reaction_update</a><li><a href=#autonomic_reaction_destroy class="table-of-contents__link toc-highlight">autonomic_reaction_destroy</a></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
|
1162
|
+
<pre tabindex=0 class="codeBlockStandalone_K9VJ thin-scrollbar codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><code class=codeBlockLines_AdAo></code></pre></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/guides/scripting-api.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/script-writing><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/troubleshooting><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Troubleshooting</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=#concepts class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href=#programming-languages class="table-of-contents__link toc-highlight">Programming Languages</a><li><a href=#using-script-runner class="table-of-contents__link toc-highlight">Using Script Runner</a><li><a href=#telemetry-types class="table-of-contents__link toc-highlight">Telemetry Types</a></ul><li><a href=#script-runner-api class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href=#migration-from-cosmos-v5-to-v6 class="table-of-contents__link toc-highlight">Migration from COSMOS v5 to v6</a><li><a href=#migration-from-cosmos-v4-to-v5 class="table-of-contents__link toc-highlight">Migration from COSMOS v4 to v5</a></ul><li><a href=#retrieving-user-input class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href=#ask class="table-of-contents__link toc-highlight">ask</a><li><a href=#ask_string class="table-of-contents__link toc-highlight">ask_string</a><li><a href=#message_box class="table-of-contents__link toc-highlight">message_box</a><li><a href=#vertical_message_box class="table-of-contents__link toc-highlight">vertical_message_box</a><li><a href=#combo_box class="table-of-contents__link toc-highlight">combo_box</a><li><a href=#get_target_file class="table-of-contents__link toc-highlight">get_target_file</a><li><a href=#put_target_file class="table-of-contents__link toc-highlight">put_target_file</a><li><a href=#delete_target_file class="table-of-contents__link toc-highlight">delete_target_file</a><li><a href=#open_file_dialog class="table-of-contents__link toc-highlight">open_file_dialog</a><li><a href=#open_files_dialog class="table-of-contents__link toc-highlight">open_files_dialog</a></ul><li><a href=#providing-information-to-the-user class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href=#prompt class="table-of-contents__link toc-highlight">prompt</a></ul><li><a href=#commands class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href=#cmd class="table-of-contents__link toc-highlight">cmd</a><li><a href=#cmd_no_range_check class="table-of-contents__link toc-highlight">cmd_no_range_check</a><li><a href=#cmd_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a><li><a href=#cmd_no_checks class="table-of-contents__link toc-highlight">cmd_no_checks</a><li><a href=#cmd_raw class="table-of-contents__link toc-highlight">cmd_raw</a><li><a href=#cmd_raw_no_range_check class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a><li><a href=#cmd_raw_no_hazardous_check class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a><li><a href=#cmd_raw_no_checks class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a><li><a href=#build_cmd class="table-of-contents__link toc-highlight">build_cmd</a><li><a href=#enable_cmd class="table-of-contents__link toc-highlight">enable_cmd</a><li><a href=#disable_cmd class="table-of-contents__link toc-highlight">disable_cmd</a><li><a href=#send_raw class="table-of-contents__link toc-highlight">send_raw</a><li><a href=#get_all_cmds class="table-of-contents__link toc-highlight">get_all_cmds</a><li><a href=#get_all_cmd_names class="table-of-contents__link toc-highlight">get_all_cmd_names</a><li><a href=#get_cmd class="table-of-contents__link toc-highlight">get_cmd</a><li><a href=#get_param class="table-of-contents__link toc-highlight">get_param</a><li><a href=#get_cmd_buffer class="table-of-contents__link toc-highlight">get_cmd_buffer</a><li><a href=#get_cmd_hazardous class="table-of-contents__link toc-highlight">get_cmd_hazardous</a><li><a href=#get_cmd_value class="table-of-contents__link toc-highlight">get_cmd_value</a><li><a href=#get_cmd_time class="table-of-contents__link toc-highlight">get_cmd_time</a><li><a href=#get_cmd_cnt class="table-of-contents__link toc-highlight">get_cmd_cnt</a><li><a href=#get_cmd_cnts class="table-of-contents__link toc-highlight">get_cmd_cnts</a><li><a href=#critical_cmd_status class="table-of-contents__link toc-highlight">critical_cmd_status</a><li><a href=#critical_cmd_approve class="table-of-contents__link toc-highlight">critical_cmd_approve</a><li><a href=#critical_cmd_reject class="table-of-contents__link toc-highlight">critical_cmd_reject</a><li><a href=#critical_cmd_can_approve class="table-of-contents__link toc-highlight">critical_cmd_can_approve</a></ul><li><a href=#command-queues class="table-of-contents__link toc-highlight">Command Queues</a><ul><li><a href=#queue_create class="table-of-contents__link toc-highlight">queue_create</a><li><a href=#queue_get class="table-of-contents__link toc-highlight">queue_get</a><li><a href=#queue_all class="table-of-contents__link toc-highlight">queue_all</a><li><a href=#queue_list class="table-of-contents__link toc-highlight">queue_list</a><li><a href=#queue_hold class="table-of-contents__link toc-highlight">queue_hold</a><li><a href=#queue_release class="table-of-contents__link toc-highlight">queue_release</a><li><a href=#queue_disable class="table-of-contents__link toc-highlight">queue_disable</a><li><a href=#queue_exec class="table-of-contents__link toc-highlight">queue_exec</a><li><a href=#queue_delete class="table-of-contents__link toc-highlight">queue_delete</a></ul><li><a href=#handling-telemetry class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href=#check-check_raw-check_formatted-check_with_units class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a><li><a href=#check_tolerance class="table-of-contents__link toc-highlight">check_tolerance</a><li><a href=#check_expression class="table-of-contents__link toc-highlight">check_expression</a><li><a href=#check_exception class="table-of-contents__link toc-highlight">check_exception</a><li><a href=#tlm-tlm_raw-tlm_formatted-tlm_with_units class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a><li><a href=#get_tlm_buffer class="table-of-contents__link toc-highlight">get_tlm_buffer</a><li><a href=#get_tlm_packet class="table-of-contents__link toc-highlight">get_tlm_packet</a><li><a href=#get_tlm_available class="table-of-contents__link toc-highlight">get_tlm_available</a><li><a href=#get_tlm_values class="table-of-contents__link toc-highlight">get_tlm_values</a><li><a href=#get_all_tlm class="table-of-contents__link toc-highlight">get_all_tlm</a><li><a href=#get_all_tlm_names class="table-of-contents__link toc-highlight">get_all_tlm_names</a><li><a href=#get_all_tlm_item_names class="table-of-contents__link toc-highlight">get_all_tlm_item_names</a><li><a href=#get_tlm class="table-of-contents__link toc-highlight">get_tlm</a><li><a href=#get_item class="table-of-contents__link toc-highlight">get_item</a><li><a href=#get_tlm_cnt class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#set_tlm class="table-of-contents__link toc-highlight">set_tlm</a><li><a href=#inject_tlm class="table-of-contents__link toc-highlight">inject_tlm</a><li><a href=#override_tlm class="table-of-contents__link toc-highlight">override_tlm</a><li><a href=#normalize_tlm class="table-of-contents__link toc-highlight">normalize_tlm</a><li><a href=#get_overrides class="table-of-contents__link toc-highlight">get_overrides</a></ul><li><a href=#packet-data-subscriptions class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href=#subscribe_packets class="table-of-contents__link toc-highlight">subscribe_packets</a><li><a href=#get_packets class="table-of-contents__link toc-highlight">get_packets</a><li><a href=#get_tlm_cnt-1 class="table-of-contents__link toc-highlight">get_tlm_cnt</a><li><a href=#get_tlm_cnts class="table-of-contents__link toc-highlight">get_tlm_cnts</a><li><a href=#get_packet_derived_items class="table-of-contents__link toc-highlight">get_packet_derived_items</a></ul><li><a href=#delays class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href=#wait class="table-of-contents__link toc-highlight">wait</a><li><a href=#wait_tolerance class="table-of-contents__link toc-highlight">wait_tolerance</a><li><a href=#wait_expression class="table-of-contents__link toc-highlight">wait_expression</a><li><a href=#wait_packet class="table-of-contents__link toc-highlight">wait_packet</a><li><a href=#wait_check class="table-of-contents__link toc-highlight">wait_check</a><li><a href=#wait_check_tolerance class="table-of-contents__link toc-highlight">wait_check_tolerance</a><li><a href=#wait_check_expression class="table-of-contents__link toc-highlight">wait_check_expression</a><li><a href=#wait_check_packet class="table-of-contents__link toc-highlight">wait_check_packet</a></ul><li><a href=#limits class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href=#limits_enabled-limits_enabled class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a><li><a href=#enable_limits class="table-of-contents__link toc-highlight">enable_limits</a><li><a href=#disable_limits class="table-of-contents__link toc-highlight">disable_limits</a><li><a href=#enable_limits_group class="table-of-contents__link toc-highlight">enable_limits_group</a><li><a href=#disable_limits_group class="table-of-contents__link toc-highlight">disable_limits_group</a><li><a href=#get_limits_groups class="table-of-contents__link toc-highlight">get_limits_groups</a><li><a href=#set_limits_set class="table-of-contents__link toc-highlight">set_limits_set</a><li><a href=#get_limits_set class="table-of-contents__link toc-highlight">get_limits_set</a><li><a href=#get_limits_sets class="table-of-contents__link toc-highlight">get_limits_sets</a><li><a href=#get_limits class="table-of-contents__link toc-highlight">get_limits</a><li><a href=#set_limits class="table-of-contents__link toc-highlight">set_limits</a><li><a href=#get_out_of_limits class="table-of-contents__link toc-highlight">get_out_of_limits</a><li><a href=#get_overall_limits_state class="table-of-contents__link toc-highlight">get_overall_limits_state</a><li><a href=#get_limits_events class="table-of-contents__link toc-highlight">get_limits_events</a></ul><li><a href=#plugins--packages class="table-of-contents__link toc-highlight">Plugins / Packages</a><ul><li><a href=#plugin_list class="table-of-contents__link toc-highlight">plugin_list</a><li><a href=#plugin_get class="table-of-contents__link toc-highlight">plugin_get</a><li><a href=#package_list class="table-of-contents__link toc-highlight">package_list</a></ul><li><a href=#targets class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href=#get_target_names class="table-of-contents__link toc-highlight">get_target_names</a><li><a href=#get_target class="table-of-contents__link toc-highlight">get_target</a><li><a href=#get_target_interfaces class="table-of-contents__link toc-highlight">get_target_interfaces</a></ul><li><a href=#interfaces class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href=#get_interface class="table-of-contents__link toc-highlight">get_interface</a><li><a href=#get_interface_names class="table-of-contents__link toc-highlight">get_interface_names</a><li><a href=#connect_interface class="table-of-contents__link toc-highlight">connect_interface</a><li><a href=#disconnect_interface class="table-of-contents__link toc-highlight">disconnect_interface</a><li><a href=#start_raw_logging_interface class="table-of-contents__link toc-highlight">start_raw_logging_interface</a><li><a href=#stop_raw_logging_interface class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a><li><a href=#get_all_interface_info class="table-of-contents__link toc-highlight">get_all_interface_info</a><li><a href=#map_target_to_interface class="table-of-contents__link toc-highlight">map_target_to_interface</a><li><a href=#interface_cmd class="table-of-contents__link toc-highlight">interface_cmd</a><li><a href=#interface_protocol_cmd class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></ul><li><a href=#routers class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href=#connect_router class="table-of-contents__link toc-highlight">connect_router</a><li><a href=#disconnect_router class="table-of-contents__link toc-highlight">disconnect_router</a><li><a href=#get_router_names class="table-of-contents__link toc-highlight">get_router_names</a><li><a href=#get_router class="table-of-contents__link toc-highlight">get_router</a><li><a href=#get_all_router_info class="table-of-contents__link toc-highlight">get_all_router_info</a><li><a href=#start_raw_logging_router class="table-of-contents__link toc-highlight">start_raw_logging_router</a><li><a href=#stop_raw_logging_router class="table-of-contents__link toc-highlight">stop_raw_logging_router</a><li><a href=#router_cmd class="table-of-contents__link toc-highlight">router_cmd</a><li><a href=#router_protocol_cmd class="table-of-contents__link toc-highlight">router_protocol_cmd</a></ul><li><a href=#tables class="table-of-contents__link toc-highlight">Tables</a><ul><li><a href=#table_create_binary class="table-of-contents__link toc-highlight">table_create_binary</a><li><a href=#table_create_report class="table-of-contents__link toc-highlight">table_create_report</a></ul><li><a href=#stashing-data class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href=#stash_set class="table-of-contents__link toc-highlight">stash_set</a><li><a href=#stash_get class="table-of-contents__link toc-highlight">stash_get</a><li><a href=#stash_all class="table-of-contents__link toc-highlight">stash_all</a><li><a href=#stash_keys class="table-of-contents__link toc-highlight">stash_keys</a><li><a href=#stash_delete class="table-of-contents__link toc-highlight">stash_delete</a></ul><li><a href=#telemetry-screens class="table-of-contents__link toc-highlight">Telemetry Screens</a><ul><li><a href=#display_screen class="table-of-contents__link toc-highlight">display_screen</a><li><a href=#clear_screen class="table-of-contents__link toc-highlight">clear_screen</a><li><a href=#clear_all_screens class="table-of-contents__link toc-highlight">clear_all_screens</a><li><a href=#delete_screen class="table-of-contents__link toc-highlight">delete_screen</a><li><a href=#get_screen_list class="table-of-contents__link toc-highlight">get_screen_list</a><li><a href=#get_screen_definition class="table-of-contents__link toc-highlight">get_screen_definition</a><li><a href=#create_screen class="table-of-contents__link toc-highlight">create_screen</a><li><a href=#local_screen class="table-of-contents__link toc-highlight">local_screen</a></ul><li><a href=#script-runner-scripts class="table-of-contents__link toc-highlight">Script Runner Scripts</a><ul><li><a href=#start class="table-of-contents__link toc-highlight">start</a><li><a href=#goto class="table-of-contents__link toc-highlight">goto</a><li><a href=#load_utility class="table-of-contents__link toc-highlight">load_utility</a><li><a href=#script_list class="table-of-contents__link toc-highlight">script_list</a><li><a href=#script_create class="table-of-contents__link toc-highlight">script_create</a><li><a href=#script_body class="table-of-contents__link toc-highlight">script_body</a><li><a href=#script_delete class="table-of-contents__link toc-highlight">script_delete</a><li><a href=#script_run class="table-of-contents__link toc-highlight">script_run</a><li><a href=#script_lock class="table-of-contents__link toc-highlight">script_lock</a><li><a href=#script_unlock class="table-of-contents__link toc-highlight">script_unlock</a><li><a href=#script_syntax_check class="table-of-contents__link toc-highlight">script_syntax_check</a><li><a href=#script_instrumented class="table-of-contents__link toc-highlight">script_instrumented</a><li><a href=#script_delete_all_breakpoints class="table-of-contents__link toc-highlight">script_delete_all_breakpoints</a><li><a href=#step_mode class="table-of-contents__link toc-highlight">step_mode</a><li><a href=#run_mode class="table-of-contents__link toc-highlight">run_mode</a><li><a href=#disconnect_script class="table-of-contents__link toc-highlight">disconnect_script</a><li><a href=#running_script_list class="table-of-contents__link toc-highlight">running_script_list</a><li><a href=#script_get class="table-of-contents__link toc-highlight">script_get</a><li><a href=#running_script_stop class="table-of-contents__link toc-highlight">running_script_stop</a><li><a href=#running_script_pause class="table-of-contents__link toc-highlight">running_script_pause</a><li><a href=#running_script_retry class="table-of-contents__link toc-highlight">running_script_retry</a><li><a href=#running_script_go class="table-of-contents__link toc-highlight">running_script_go</a><li><a href=#running_script_execute_while_paused class="table-of-contents__link toc-highlight">running_script_execute_while_paused</a><li><a href=#running_script_step class="table-of-contents__link toc-highlight">running_script_step</a><li><a href=#running_script_delete class="table-of-contents__link toc-highlight">running_script_delete</a><li><a href=#completed_script_list class="table-of-contents__link toc-highlight">completed_script_list</a></ul><li><a href=#script-runner-settings class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href=#set_line_delay class="table-of-contents__link toc-highlight">set_line_delay</a><li><a href=#get_line_delay class="table-of-contents__link toc-highlight">get_line_delay</a><li><a href=#set_max_output class="table-of-contents__link toc-highlight">set_max_output</a><li><a href=#get_max_output class="table-of-contents__link toc-highlight">get_max_output</a><li><a href=#disable_instrumentation class="table-of-contents__link toc-highlight">disable_instrumentation</a></ul><li><a href=#script-runner-suites class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href=#add_group-add_group_setup-add_group_teardown-add_script class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></ul><li><a href=#timelines class="table-of-contents__link toc-highlight">Timelines</a><ul><li><a href=#list_timelines class="table-of-contents__link toc-highlight">list_timelines</a><li><a href=#create_timeline class="table-of-contents__link toc-highlight">create_timeline</a><li><a href=#get_timeline class="table-of-contents__link toc-highlight">get_timeline</a><li><a href=#set_timeline_color class="table-of-contents__link toc-highlight">set_timeline_color</a><li><a href=#delete_timeline class="table-of-contents__link toc-highlight">delete_timeline</a><li><a href=#create_timeline_activity class="table-of-contents__link toc-highlight">create_timeline_activity</a><li><a href=#get_timeline_activity class="table-of-contents__link toc-highlight">get_timeline_activity</a><li><a href=#get_timeline_activities class="table-of-contents__link toc-highlight">get_timeline_activities</a><li><a href=#delete_timeline_activity class="table-of-contents__link toc-highlight">delete_timeline_activity</a></ul><li><a href=#metadata class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href=#metadata_all class="table-of-contents__link toc-highlight">metadata_all</a><li><a href=#metadata_get class="table-of-contents__link toc-highlight">metadata_get</a><li><a href=#metadata_set class="table-of-contents__link toc-highlight">metadata_set</a><li><a href=#metadata_update class="table-of-contents__link toc-highlight">metadata_update</a><li><a href=#metadata_input class="table-of-contents__link toc-highlight">metadata_input</a></ul><li><a href=#settings class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href=#list_settings class="table-of-contents__link toc-highlight">list_settings</a><li><a href=#get_all_settings class="table-of-contents__link toc-highlight">get_all_settings</a><li><a href=#get_setting-get_settings class="table-of-contents__link toc-highlight">get_setting, get_settings</a><li><a href=#set_setting class="table-of-contents__link toc-highlight">set_setting</a></ul><li><a href=#configuration class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href=#config_tool_names class="table-of-contents__link toc-highlight">config_tool_names</a><li><a href=#list_configs class="table-of-contents__link toc-highlight">list_configs</a><li><a href=#load_config class="table-of-contents__link toc-highlight">load_config</a><li><a href=#save_config class="table-of-contents__link toc-highlight">save_config</a><li><a href=#delete_config class="table-of-contents__link toc-highlight">delete_config</a></ul><li><a href=#offline-access class="table-of-contents__link toc-highlight">Offline Access</a><ul><li><a href=#initialize_offline_access class="table-of-contents__link toc-highlight">initialize_offline_access</a><li><a href=#offline_access_needed class="table-of-contents__link toc-highlight">offline_access_needed</a><li><a href=#set_offline_access class="table-of-contents__link toc-highlight">set_offline_access</a></ul><li><a href=#autonomic class="table-of-contents__link toc-highlight">Autonomic</a><ul><li><a href=#autonomic_group_list class="table-of-contents__link toc-highlight">autonomic_group_list</a><li><a href=#autonomic_group_create class="table-of-contents__link toc-highlight">autonomic_group_create</a><li><a href=#autonomic_group_show class="table-of-contents__link toc-highlight">autonomic_group_show</a><li><a href=#autonomic_group_destroy class="table-of-contents__link toc-highlight">autonomic_group_destroy</a><li><a href=#autonomic_trigger_list class="table-of-contents__link toc-highlight">autonomic_trigger_list</a><li><a href=#autonomic_trigger_create class="table-of-contents__link toc-highlight">autonomic_trigger_create</a><li><a href=#autonomic_trigger_show class="table-of-contents__link toc-highlight">autonomic_trigger_show</a><li><a href=#autonomic_trigger_enable class="table-of-contents__link toc-highlight">autonomic_trigger_enable</a><li><a href=#autonomic_trigger_disable class="table-of-contents__link toc-highlight">autonomic_trigger_disable</a><li><a href=#autonomic_trigger_update class="table-of-contents__link toc-highlight">autonomic_trigger_update</a><li><a href=#autonomic_trigger_destroy class="table-of-contents__link toc-highlight">autonomic_trigger_destroy</a><li><a href=#autonomic_reaction_list class="table-of-contents__link toc-highlight">autonomic_reaction_list</a><li><a href=#autonomic_reaction_create class="table-of-contents__link toc-highlight">autonomic_reaction_create</a><li><a href=#autonomic_reaction_show class="table-of-contents__link toc-highlight">autonomic_reaction_show</a><li><a href=#autonomic_reaction_enable class="table-of-contents__link toc-highlight">autonomic_reaction_enable</a><li><a href=#autonomic_reaction_disable class="table-of-contents__link toc-highlight">autonomic_reaction_disable</a><li><a href=#autonomic_reaction_execute class="table-of-contents__link toc-highlight">autonomic_reaction_execute</a><li><a href=#autonomic_reaction_update class="table-of-contents__link toc-highlight">autonomic_reaction_update</a><li><a href=#autonomic_reaction_destroy class="table-of-contents__link toc-highlight">autonomic_reaction_destroy</a></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/troubleshooting" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Troubleshooting | 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/guides/troubleshooting><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="Troubleshooting | OpenC3 Docs"><meta data-rh=true name=description content="How to solve various issues we've encountered"><meta data-rh=true property=og:description content="How to solve various issues we've encountered"><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/guides/troubleshooting><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting","name":"Troubleshooting","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.
|
|
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-guides/troubleshooting" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Troubleshooting | 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/guides/troubleshooting><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="Troubleshooting | OpenC3 Docs"><meta data-rh=true name=description content="How to solve various issues we've encountered"><meta data-rh=true property=og:description content="How to solve various issues we've encountered"><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/guides/troubleshooting><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/troubleshooting","name":"Troubleshooting","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.0edf3032.css><script src=/tools/staticdocs/assets/js/runtime~main.44311138.js defer></script><script src=/tools/staticdocs/assets/js/main.994f9f74.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
4
|
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</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/guides/cfs>COSMOS and NASA cFS</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/guides/custom-widgets>Custom Widgets</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/guides/dynamic-packets>Dynamic Packets</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/guides/exposing-microservices>Exposing Microservices</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/guides/little-endian-bitfields>Little Endian Bitfields</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/guides/local-mode>Local Mode</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/guides/logging>Logging</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/guides/monitoring>Monitoring</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/guides/performance>Performance</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/guides/raspberrypi>Raspberry Pi</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/guides/reference-architectures>Reference Architectures</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/guides/script-writing>Script Writing Guide</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/guides/scripting-api>Scripting API Guide</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/guides/troubleshooting>Troubleshooting</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/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Troubleshooting</span></ul></nav><div class="theme-doc-markdown markdown"><header><h1>Troubleshooting</h1></header><p>We've seen a number of issues deploying COSMOS via Docker in various types of installations from single server to the cloud. This page captures some of the subtle issues we've discovered and ways to solve the problem. NOTE: Don't forget to also search our <a href=https://github.com/OpenC3/cosmos/issues target=_blank rel="noopener noreferrer">Github Issues</a> (hit '/' and start typing).</p>
|
|
@@ -50,5 +50,11 @@
|
|
|
50
50
|
<li>Completely restart Chrome. On MacOS make sure the dot below the icon in chrome is gone by long pressing the icon and choosing Quit.</li>
|
|
51
51
|
</ul>
|
|
52
52
|
</li>
|
|
53
|
+
<li>
|
|
54
|
+
<p>When using your own certs, you see an error banner with "Token is invalid" with "Failed to open TCP connection to <KEYCLOAK URL> (execution expired)".</p>
|
|
55
|
+
<p>We have seen this when a local firewall is blocking the 443 port to Keycloak. Keycloak itself can still be reachable at <code>&lt;KEYCLOAK URL&gt;/auth</code> which makes it feel like this is not a firewall issue. However, if you exec into the <code>cmd-tlm-api</code> container you should be able to curl the following Keycloak URL:</p>
|
|
56
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function" style="color:rgb(130, 170, 255)">docker</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">ps</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">docker</span><span class="token plain"> </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">exec</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-it</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">CONTAINER ID FOR CMD_TLM_API</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">sh</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">$ </span><span class="token function" style="color:rgb(130, 170, 255)">ping</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">KEYCLOAK URL</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">$ </span><span class="token function" style="color:rgb(130, 170, 255)">curl</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">-vvv</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">KEYCLOAK URL</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain">/realms/openc3/protocol/openid-connect/certs</span><br></span></code></pre></div></div>
|
|
57
|
+
<p>If this does not return you could be blocking the 443 port to Keycloak. Update your firewall settings and try again.</p>
|
|
58
|
+
</li>
|
|
53
59
|
</ol>
|
|
54
60
|
<p>Encountering an issue not on this list? If you're a customer, please get in touch at <a href=mailto:support@openc3.com target=_blank rel="noopener noreferrer">support@openc3.com</a>.</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/guides/troubleshooting.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/scripting-api><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Scripting API Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Development</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|