openc3-cosmos-tool-docs 6.8.1 → 6.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/Rakefile +1 -1
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/css/styles.946be27d.css +1 -0
- data/tools/staticdocs/assets/js/019369f3.64763f3d.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.3d58085e.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +1 -0
- data/tools/staticdocs/assets/js/{0f5d161c.0727eb1b.js → 0f5d161c.978b9fee.js} +1 -1
- data/tools/staticdocs/assets/js/0ff569c9.27128023.js +1 -0
- data/tools/staticdocs/assets/js/10209fc9.669ef887.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.1a538098.js +1 -0
- data/tools/staticdocs/assets/js/{13196248.9e1ebaa5.js → 13196248.f932d5bd.js} +1 -1
- data/tools/staticdocs/assets/js/{13c1b4e4.6446ccbc.js → 13c1b4e4.9735bb59.js} +1 -1
- data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +1 -0
- data/tools/staticdocs/assets/js/{1e02e6a3.a89f2446.js → 1e02e6a3.da7b7250.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.0955283c.js → 2047b354.c86efa5f.js} +1 -1
- data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.858cb22d.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +1 -0
- data/tools/staticdocs/assets/js/3326.2db66e1b.js +4 -0
- data/tools/staticdocs/assets/js/3402.80344ef5.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +1 -0
- data/tools/staticdocs/assets/js/{3dd7ef3b.f43cd057.js → 3dd7ef3b.ceb26a04.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.f6769d57.js +1 -0
- data/tools/staticdocs/assets/js/4071.821f3b2b.js +1 -0
- data/tools/staticdocs/assets/js/{411898ad.28293824.js → 411898ad.8ed3452c.js} +1 -1
- data/tools/staticdocs/assets/js/42170351.7ff72adc.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +1 -0
- data/tools/staticdocs/assets/js/5072.9a0a2752.js +1 -0
- data/tools/staticdocs/assets/js/{53ca7c5b.9468b8ed.js → 53ca7c5b.3ae5bb0f.js} +1 -1
- data/tools/staticdocs/assets/js/54d0d530.2f7aa091.js +1 -0
- data/tools/staticdocs/assets/js/5525.dd1645b0.js +101 -0
- data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.821e5ed4.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +1 -0
- data/tools/staticdocs/assets/js/6246.60dfff30.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.dc5bae56.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.d197d085.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d400f853.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.7e6fb4fd.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.338d2338.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +1 -0
- data/tools/staticdocs/assets/js/{8434.a3e5442b.js → 9623.44668503.js} +1 -1
- data/tools/staticdocs/assets/js/{964eb012.4253acd5.js → 964eb012.c7f626c5.js} +1 -1
- data/tools/staticdocs/assets/js/97535711.a6342866.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +1 -0
- data/tools/staticdocs/assets/js/{9d6e81d0.b9f15524.js → 9d6e81d0.879c9e9e.js} +1 -1
- data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.758701f0.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.6bcbf484.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.9e7f0be7.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +1 -0
- data/tools/staticdocs/assets/js/{b9f60ba6.2c4823f0.js → b9f60ba6.63638354.js} +1 -1
- data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +1 -0
- data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +1 -0
- data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.6b4ab31e.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.4e811739.js +1 -0
- data/tools/staticdocs/assets/js/{dc5f7beb.15b70d4b.js → dc5f7beb.c703e464.js} +1 -1
- data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.8591b830.js +1 -0
- data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +1 -0
- data/tools/staticdocs/assets/js/{fd886806.f7bfd80c.js → fd886806.fb8a587e.js} +1 -1
- data/tools/staticdocs/assets/js/main.331b7e10.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.53a0c91e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +46 -46
- data/tools/staticdocs/docs/configuration/command.html +97 -97
- data/tools/staticdocs/docs/configuration/conversions.html +53 -53
- data/tools/staticdocs/docs/configuration/format.html +22 -22
- data/tools/staticdocs/docs/configuration/interfaces.html +55 -55
- data/tools/staticdocs/docs/configuration/limits-response.html +10 -10
- data/tools/staticdocs/docs/configuration/plugins.html +127 -127
- data/tools/staticdocs/docs/configuration/processors.html +17 -17
- data/tools/staticdocs/docs/configuration/protocols.html +66 -66
- data/tools/staticdocs/docs/configuration/ssl-tls.html +15 -15
- data/tools/staticdocs/docs/configuration/table.html +53 -53
- data/tools/staticdocs/docs/configuration/target.html +21 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +289 -289
- data/tools/staticdocs/docs/configuration/telemetry.html +86 -86
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +14 -14
- data/tools/staticdocs/docs/development/developing.html +27 -27
- data/tools/staticdocs/docs/development/json-api.html +15 -15
- data/tools/staticdocs/docs/development/log-structure.html +13 -13
- data/tools/staticdocs/docs/development/roadmap.html +4 -4
- data/tools/staticdocs/docs/development/streaming-api.html +24 -24
- data/tools/staticdocs/docs/development/testing.html +20 -20
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/cli.html +39 -39
- data/tools/staticdocs/docs/getting-started/generators.html +25 -25
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
- data/tools/staticdocs/docs/getting-started/installation.html +23 -21
- data/tools/staticdocs/docs/getting-started/key-concepts.html +20 -20
- data/tools/staticdocs/docs/getting-started/podman.html +23 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
- data/tools/staticdocs/docs/getting-started/upgrading.html +47 -47
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +19 -12
- data/tools/staticdocs/docs/guides/cfs.html +32 -32
- data/tools/staticdocs/docs/guides/custom-widgets.html +36 -36
- data/tools/staticdocs/docs/guides/dynamic-packets.html +8 -8
- data/tools/staticdocs/docs/guides/exposing-microservices.html +11 -11
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +4 -4
- data/tools/staticdocs/docs/guides/local-mode.html +13 -13
- data/tools/staticdocs/docs/guides/logging.html +9 -9
- data/tools/staticdocs/docs/guides/monitoring.html +18 -18
- data/tools/staticdocs/docs/guides/performance.html +10 -10
- data/tools/staticdocs/docs/guides/raspberrypi.html +4 -4
- data/tools/staticdocs/docs/guides/reference-architectures.html +6 -6
- data/tools/staticdocs/docs/guides/script-writing.html +80 -80
- data/tools/staticdocs/docs/guides/scripting-api.html +707 -635
- data/tools/staticdocs/docs/guides/troubleshooting.html +8 -7
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +12 -12
- data/tools/staticdocs/docs/meta/licenses.html +9 -9
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/xtce.html +12 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/admin.html +24 -24
- data/tools/staticdocs/docs/tools/autonomic.html +19 -19
- data/tools/staticdocs/docs/tools/bucket-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/calendar.html +18 -18
- data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +20 -20
- data/tools/staticdocs/docs/tools/command-history.html +6 -6
- data/tools/staticdocs/docs/tools/command-queue.html +8 -8
- data/tools/staticdocs/docs/tools/data-extractor.html +25 -25
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +16 -16
- data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/packet-viewer.html +12 -12
- data/tools/staticdocs/docs/tools/script-runner.html +43 -43
- data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
- data/tools/staticdocs/docs/tools/table-manager.html +11 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -22
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +11 -11
- data/tools/staticdocs/index.html +2 -2
- data/tools/staticdocs/lunr-index-1759527994448.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1759527994448.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +92 -92
- data/tools/staticdocs/assets/css/styles.0edf3032.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.5366d64b.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.eb311155.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.974abc47.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +0 -1
- data/tools/staticdocs/assets/js/10209fc9.ae369363.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.32c30401.js +0 -1
- data/tools/staticdocs/assets/js/1085.d1eba438.js +0 -1
- data/tools/staticdocs/assets/js/1319.d9ec0592.js +0 -101
- data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.81906212.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.db29df30.js +0 -1
- data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.35825078.js +0 -1
- data/tools/staticdocs/assets/js/5074.653f3924.js +0 -1
- data/tools/staticdocs/assets/js/5410.60ab1dba.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +0 -1
- data/tools/staticdocs/assets/js/59ed27a4.8eb3444b.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +0 -1
- data/tools/staticdocs/assets/js/6242.bdac32c1.js +0 -4
- data/tools/staticdocs/assets/js/6831b732.7cf97282.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.b96d263c.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +0 -1
- data/tools/staticdocs/assets/js/8851.4837d29a.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +0 -1
- data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +0 -1
- data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.791cdc39.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.2695e35a.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.71b17b00.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.c8eb51b6.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.e240f32e.js +0 -1
- data/tools/staticdocs/assets/js/b38a6d74.7363be85.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.2a473696.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.482b8f7b.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +0 -1
- data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +0 -1
- data/tools/staticdocs/assets/js/f75a5f33.4d2501bc.js +0 -1
- data/tools/staticdocs/assets/js/main.994f9f74.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.44311138.js +0 -1
- data/tools/staticdocs/lunr-index-1757781681330.json +0 -1
- data/tools/staticdocs/search-doc-1757781681330.json +0 -1
|
@@ -1,85 +1,85 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/table" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/table" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Tables | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/configuration/table /><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="Tables | OpenC3 Docs"/><meta data-rh=true name=description content="Table definition file format and keywords"/><meta data-rh=true property=og:description content="Table definition file format and keywords"/><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/configuration/table /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/table hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/table hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration","name":"Configuration","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/configuration/table","name":"Tables","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.53a0c91e.js defer></script><script src=/tools/staticdocs/assets/js/main.331b7e10.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
|
-
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions>Conversions</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/processors>Processors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/limits-response>Limits Response</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Tables</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>Tables</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=table-definition-files>Table Definition Files<a href=#table-definition-files class=hash-link aria-label="Direct link to Table Definition Files" title="Direct link to Table Definition Files"></a></h2>
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format><span title="File Format" class=linkLabel_THKR>File Format</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins><span title=Plugins class=linkLabel_THKR>Plugins</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target><span title=Targets class=linkLabel_THKR>Targets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command><span title=Commands class=linkLabel_THKR>Commands</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry><span title=Telemetry class=linkLabel_THKR>Telemetry</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces><span title=Interfaces class=linkLabel_THKR>Interfaces</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols><span title=Protocols class=linkLabel_THKR>Protocols</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors><span title=Accessors class=linkLabel_THKR>Accessors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/conversions><span title=Conversions class=linkLabel_THKR>Conversions</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/processors><span title=Processors class=linkLabel_THKR>Processors</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/limits-response><span title="Limits Response" class=linkLabel_THKR>Limits Response</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/table><span title=Tables class=linkLabel_THKR>Tables</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens><span title=Screens class=linkLabel_THKR>Screens</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls><span title=SSL-TLS class=linkLabel_THKR>SSL-TLS</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></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="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/configuration><span>Configuration</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Tables</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Tables</h1></header><h2 class="anchor anchorWithStickyNavbar_TUrh" id=table-definition-files>Table Definition Files<a href=#table-definition-files class=hash-link aria-label="Direct link to Table Definition Files" title="Direct link to Table Definition Files" translate=no></a></h2>
|
|
5
5
|
<p>Table definition files define the binary tables that can be displayed in COSMOS <a href=/tools/staticdocs/docs/tools/table-manager>Table Manager</a>
|
|
6
6
|
. Table definitions are defined in the target's tables/config directory and are typically named after the table such as <code>PPSSelectionTable_def.txt</code>. The <code>_def.txt</code> extension helps to identify the file as a table definition. Table definitions can be combined using the <code>TABLEFILE</code> keyword. This allows you to build individual table components into a larger binary.</p>
|
|
7
7
|
<p>The Table definition files share a lot of similarity with the <a href=/tools/staticdocs/docs/configuration/command>Command Configuration</a>. You have the same data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data.</p>
|
|
8
8
|
<div style=clear:both></div>
|
|
9
9
|
<h1>Table Keywords</h1>
|
|
10
|
-
<h2 class="anchor
|
|
10
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=tablefile>TABLEFILE<a href=#tablefile class=hash-link aria-label="Direct link to TABLEFILE" title="Direct link to TABLEFILE" translate=no></a></h2>
|
|
11
11
|
<p><strong>Specify another file to open and process for table definitions</strong></p>
|
|
12
12
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>File Name<td>Name of the file. The file will be looked for in the directory of the current definition file.<td>True</table>
|
|
13
|
-
<h2 class="anchor
|
|
13
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=table>TABLE<a href=#table class=hash-link aria-label="Direct link to TABLE" title="Direct link to TABLE" translate=no></a></h2>
|
|
14
14
|
<p><strong>Start a new table definition</strong></p>
|
|
15
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the table in quotes. The name will appear on the GUI tab.<td>True<tr><td>Endianness<td>Indicates if the data in this table is in Big Endian or Little Endian format<br
|
|
15
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the table in quotes. The name will appear on the GUI tab.<td>True<tr><td>Endianness<td>Indicates if the data in this table is in Big Endian or Little Endian format<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>True<tr><td>Display<td>Indicates the table contains KEY_VALUE rows (e.g. each row is unique), or a ROW_COLUMN table with identical rows containing different values.<br/><br/>Valid Values: <span class=values>KEY_VALUE, ROW_COLUMN</span><td>False</table>
|
|
16
16
|
<p>When Display is KEY_VALUE the remaining parameters are:</p>
|
|
17
17
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Description<td>Description of the table in quotes. The description is used in mouseover popups and status line information.<td>False</table>
|
|
18
18
|
<p>When Display is ROW_COLUMN the remaining parameters are:</p>
|
|
19
19
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Rows<td>The number of rows in the table<td>False<tr><td>Description<td>Description of the table in quotes. The description is used in mouseover popups and status line information.<td>False</table>
|
|
20
|
-
<h2 class="anchor
|
|
20
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=table-modifiers>TABLE Modifiers<a href=#table-modifiers class=hash-link aria-label="Direct link to TABLE Modifiers" title="Direct link to TABLE Modifiers" translate=no></a></h2>
|
|
21
21
|
<p>The following keywords must follow a TABLE keyword.</p>
|
|
22
|
-
<h3 class="anchor
|
|
22
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=parameter>PARAMETER<a href=#parameter class=hash-link aria-label="Direct link to PARAMETER" title="Direct link to PARAMETER" translate=no></a></h3>
|
|
23
23
|
<p><strong>Defines a parameter in the current table</strong></p>
|
|
24
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the table.<td>True<tr><td>Bit Offset<td>Bit offset into the table of the Most Significant Bit of this parameter. May be negative to indicate an offset from the end of the table. Always use a bit offset of 0 for derived parameters.<td>True<tr><td>Bit Size<td>Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'.<td>True<tr><td>Data Type<td>Data Type of this parameter<br
|
|
24
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the table.<td>True<tr><td>Bit Offset<td>Bit offset into the table of the Most Significant Bit of this parameter. May be negative to indicate an offset from the end of the table. Always use a bit offset of 0 for derived parameters.<td>True<tr><td>Bit Size<td>Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'.<td>True<tr><td>Data Type<td>Data Type of this parameter<br/><br/>Valid Values: <span class=values>INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span><td>True</table>
|
|
25
25
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
26
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
26
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
27
27
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
28
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br
|
|
29
|
-
<h3 class="anchor
|
|
28
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
29
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=parameter-modifiers>PARAMETER Modifiers<a href=#parameter-modifiers class=hash-link aria-label="Direct link to PARAMETER Modifiers" title="Direct link to PARAMETER Modifiers" translate=no></a></h3>
|
|
30
30
|
<p>The following keywords must follow a PARAMETER keyword.</p>
|
|
31
|
-
<h4 class="anchor
|
|
31
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=format_string>FORMAT_STRING<a href=#format_string class=hash-link aria-label="Direct link to FORMAT_STRING" title="Direct link to FORMAT_STRING" translate=no></a></h4>
|
|
32
32
|
<p><strong>Adds printf style formatting</strong></p>
|
|
33
33
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Format<td>How to format using printf syntax. For example, '0x%0X' will display the value in hex.<td>True</table>
|
|
34
34
|
<p>Example Usage:</p>
|
|
35
|
-
<div class="language-ruby
|
|
36
|
-
<h4 class="anchor
|
|
35
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><br/></span></code></pre></div></div>
|
|
36
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=units>UNITS<a href=#units class=hash-link aria-label="Direct link to UNITS" title="Direct link to UNITS" translate=no></a></h4>
|
|
37
37
|
<p><strong>Add displayed units</strong></p>
|
|
38
38
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Full Name<td>Full name of the units type, e.g. Celsius<td>True<tr><td>Abbreviated<td>Abbreviation for the units, e.g. C<td>True</table>
|
|
39
39
|
<p>Example Usage:</p>
|
|
40
|
-
<div class="language-ruby
|
|
41
|
-
<h4 class="anchor
|
|
40
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Celsius </span><span class="token constant" style="color:rgb(130, 170, 255)">C</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">UNITS</span><span class="token plain"> Kilometers </span><span class="token constant" style="color:rgb(130, 170, 255)">KM</span><br/></span></code></pre></div></div>
|
|
41
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=description>DESCRIPTION<a href=#description class=hash-link aria-label="Direct link to DESCRIPTION" title="Direct link to DESCRIPTION" translate=no></a></h4>
|
|
42
42
|
<p><strong>Override the defined description</strong></p>
|
|
43
43
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new description<td>True</table>
|
|
44
|
-
<h4 class="anchor
|
|
44
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=meta>META<a href=#meta class=hash-link aria-label="Direct link to META" title="Direct link to META" translate=no></a></h4>
|
|
45
45
|
<p><strong>Stores custom user metadata</strong></p>
|
|
46
46
|
<p>Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files.</p>
|
|
47
47
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Meta Name<td>Name of the metadata to store<td>True<tr><td>Meta Values<td>One or more values to be stored for this Meta Name<td>False</table>
|
|
48
48
|
<p>Example Usage:</p>
|
|
49
|
-
<div class="language-ruby
|
|
50
|
-
<h4 class="anchor
|
|
49
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">META</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEST</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"This parameter is for test purposes only"</span><br/></span></code></pre></div></div>
|
|
50
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=overlap>OVERLAP<a href=#overlap class=hash-link aria-label="Direct link to OVERLAP" title="Direct link to OVERLAP" translate=no></a></h4>
|
|
51
51
|
<p><div class=right>(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
|
52
52
|
<p>If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and suppresses the warning message.</p>
|
|
53
|
-
<h4 class="anchor
|
|
53
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=key>KEY<a href=#key class=hash-link aria-label="Direct link to KEY" title="Direct link to KEY" translate=no></a></h4>
|
|
54
54
|
<p><div class=right>(Since 5.0.10)</div><strong>Defines the key used to access this raw value in the packet.</strong><p></p>
|
|
55
55
|
<p>Keys are often <a href=https://en.wikipedia.org/wiki/JSONPath target=_blank rel="noopener noreferrer">JSONPath</a> or <a href=https://en.wikipedia.org/wiki/XPath target=_blank rel="noopener noreferrer">XPath</a> strings</p>
|
|
56
56
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key string<td>The key to access this item<td>True</table>
|
|
57
57
|
<p>Example Usage:</p>
|
|
58
|
-
<div class="language-ruby
|
|
59
|
-
<h4 class="anchor
|
|
58
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">KEY</span><span class="token plain"> $</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">book</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">title</span><br/></span></code></pre></div></div>
|
|
59
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=variable_bit_size>VARIABLE_BIT_SIZE<a href=#variable_bit_size class=hash-link aria-label="Direct link to VARIABLE_BIT_SIZE" title="Direct link to VARIABLE_BIT_SIZE" translate=no></a></h4>
|
|
60
60
|
<p><div class=right>(Since 5.18.0)</div><strong>Marks an item as having its bit size defined by another length item</strong><p></p>
|
|
61
61
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Length Item Name<td>The name of the associated length item<td>True<tr><td>Length Bits Per Count<td>Bits per count of the length item. Defaults to 8<td>False<tr><td>Length Value Bit Offset<td>Offset in Bits to Apply to Length Field Value. Defaults to 0<td>False</table>
|
|
62
|
-
<h4 class="anchor
|
|
62
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=obfuscate>OBFUSCATE<a href=#obfuscate class=hash-link aria-label="Direct link to OBFUSCATE" title="Direct link to OBFUSCATE" translate=no></a></h4>
|
|
63
63
|
<p><div class=right>(Since 6.6.0)</div><strong>Hides the item value in the UI, text logs, and raw binary file</strong><p></p>
|
|
64
|
-
<h4 class="anchor
|
|
64
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=required>REQUIRED<a href=#required class=hash-link aria-label="Direct link to REQUIRED" title="Direct link to REQUIRED" translate=no></a></h4>
|
|
65
65
|
<p><strong>Parameter is required to be populated in scripts</strong></p>
|
|
66
66
|
<p>When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition.</p>
|
|
67
|
-
<h4 class="anchor
|
|
67
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=minimum_value>MINIMUM_VALUE<a href=#minimum_value class=hash-link aria-label="Direct link to MINIMUM_VALUE" title="Direct link to MINIMUM_VALUE" translate=no></a></h4>
|
|
68
68
|
<p><strong>Override the defined minimum value</strong></p>
|
|
69
69
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new minimum value for the parameter<td>True</table>
|
|
70
|
-
<h4 class="anchor
|
|
70
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=maximum_value>MAXIMUM_VALUE<a href=#maximum_value class=hash-link aria-label="Direct link to MAXIMUM_VALUE" title="Direct link to MAXIMUM_VALUE" translate=no></a></h4>
|
|
71
71
|
<p><strong>Override the defined maximum value</strong></p>
|
|
72
72
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new maximum value for the parameter<td>True</table>
|
|
73
|
-
<h4 class="anchor
|
|
73
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=default_value>DEFAULT_VALUE<a href=#default_value class=hash-link aria-label="Direct link to DEFAULT_VALUE" title="Direct link to DEFAULT_VALUE" translate=no></a></h4>
|
|
74
74
|
<p><strong>Override the defined default value</strong></p>
|
|
75
75
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new default value for the parameter<td>True</table>
|
|
76
|
-
<h4 class="anchor
|
|
76
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=state>STATE<a href=#state class=hash-link aria-label="Direct link to STATE" title="Direct link to STATE" translate=no></a></h4>
|
|
77
77
|
<p><strong>Defines a key/value pair for the current command parameter</strong></p>
|
|
78
78
|
<p>Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error.</p>
|
|
79
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>The string state name<td>True<tr><td>Value<td>The numerical state value<td>True<tr><td>Hazardous / Disable Messages<td>Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.<br
|
|
79
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key<td>The string state name<td>True<tr><td>Value<td>The numerical state value<td>True<tr><td>Hazardous / Disable Messages<td>Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.<br/><br/>Valid Values: <span class=values>HAZARDOUS</span><td>False<tr><td>Hazardous Description<td>String describing why this state is hazardous<td>False</table>
|
|
80
80
|
<p>Example Usage:</p>
|
|
81
|
-
<div class="language-ruby
|
|
82
|
-
<h4 class="anchor
|
|
81
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Enable setting"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FALSE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1024</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"String parameter"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"NOOP"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE_MESSAGES</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ARM LASER"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"ARM LASER"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HAZARDOUS</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Arming the laser is an eye safety hazard"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"FIRE LASER"</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"FIRE LASER"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HAZARDOUS</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"WARNING! Laser will be fired!"</span><br/></span></code></pre></div></div>
|
|
82
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=write_conversion>WRITE_CONVERSION<a href=#write_conversion class=hash-link aria-label="Direct link to WRITE_CONVERSION" title="Direct link to WRITE_CONVERSION" translate=no></a></h4>
|
|
83
83
|
<p><strong>Applies a conversion when writing the current command parameter</strong></p>
|
|
84
84
|
<p>Conversions are implemented in a custom Ruby or Python file which should be
|
|
85
85
|
located in the target's lib folder. The class must inherit from Conversion.
|
|
@@ -97,21 +97,21 @@ and should be specified as a string. For a full example see the IP_ADDRESS param
|
|
|
97
97
|
in the TIME_OFFSET command definition of the COSMOS Demo
|
|
98
98
|
<a href=https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt target=_blank rel="noopener noreferrer">INST inst_cmds.txt</a>
|
|
99
99
|
or <a href=https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt target=_blank rel="noopener noreferrer">INST2 inst_cmds.txt</a>.</p>
|
|
100
|
-
<div class="theme-admonition theme-admonition-info
|
|
100
|
+
<div class="theme-admonition theme-admonition-info admonition_AUqJ alert alert--info"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_ISwi><p>When a command is built, each item gets written (and write conversions are run)
|
|
101
101
|
to set the default value. Then items are written (again write conversions are run)
|
|
102
102
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
103
103
|
no guarantees which parameters have already been written. The packet itself has a
|
|
104
104
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
105
105
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
106
106
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Class Filename<td>The filename which contains the Ruby or Python class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'. Note the built-in Python conversions must specify the full path to the file, e.g. 'openc3/conversions/bit_reverse_conversion.py'.<td>True<tr><td>Parameter<td>Additional parameter values for the conversion which are passed to the class constructor.<td>False</table>
|
|
107
|
-
<div class="tabs-container
|
|
108
|
-
<h4 class="anchor
|
|
107
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">WRITE_CONVERSION openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">conversions</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">ip_write_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">WRITE_CONVERSION</span><span class="token plain"> ip_write_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><br/></span></code></pre></div></div></div></div></div>
|
|
108
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=poly_write_conversion>POLY_WRITE_CONVERSION<a href=#poly_write_conversion class=hash-link aria-label="Direct link to POLY_WRITE_CONVERSION" title="Direct link to POLY_WRITE_CONVERSION" translate=no></a></h4>
|
|
109
109
|
<p><strong>Adds a polynomial conversion factor to the current command parameter</strong></p>
|
|
110
110
|
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#polynomial_conversion>Polynomial Conversion</a> for more information.</p>
|
|
111
|
-
<h4 class="anchor
|
|
111
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=seg_poly_write_conversion>SEG_POLY_WRITE_CONVERSION<a href=#seg_poly_write_conversion class=hash-link aria-label="Direct link to SEG_POLY_WRITE_CONVERSION" title="Direct link to SEG_POLY_WRITE_CONVERSION" translate=no></a></h4>
|
|
112
112
|
<p><strong>Adds a segmented polynomial conversion factor to the current command parameter</strong></p>
|
|
113
113
|
<p>See <a href=/tools/staticdocs/docs/configuration/conversions#segmented_polynomial_conversion>Segmented Polynomial Conversion</a> for more information.</p>
|
|
114
|
-
<h4 class="anchor
|
|
114
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=generic_write_conversion_start>GENERIC_WRITE_CONVERSION_START<a href=#generic_write_conversion_start class=hash-link aria-label="Direct link to GENERIC_WRITE_CONVERSION_START" title="Direct link to GENERIC_WRITE_CONVERSION_START" translate=no></a></h4>
|
|
115
115
|
<p><strong>Start a generic write conversion</strong></p>
|
|
116
116
|
<p>Adds a generic conversion function to the current command parameter.
|
|
117
117
|
This conversion factor is applied to the value entered by the user before it
|
|
@@ -122,42 +122,42 @@ class (Note, referencing the packet as 'myself' is still supported for backwards
|
|
|
122
122
|
compatibility). The last line of code should return the converted
|
|
123
123
|
value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
|
|
124
124
|
code for the conversion have been given.</p>
|
|
125
|
-
<div class="theme-admonition theme-admonition-info
|
|
125
|
+
<div class="theme-admonition theme-admonition-info admonition_AUqJ alert alert--info"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_ISwi><p>When a command is built, each item gets written (and write conversions are run)
|
|
126
126
|
to set the default value. Then items are written (again write conversions are run)
|
|
127
127
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
128
128
|
no guarantees which parameters have already been written. The packet itself has a
|
|
129
129
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
130
130
|
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
131
|
-
<div class="theme-admonition theme-admonition-warning
|
|
132
|
-
<div class="tabs-container
|
|
133
|
-
<h4 class="anchor
|
|
131
|
+
<div class="theme-admonition theme-admonition-warning admonition_AUqJ alert alert--warning"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>warning</div><div class=admonitionContent_ISwi><p>Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance.</div></div>
|
|
132
|
+
<div class="theme-tabs-container tabs-container tabList_MlhV"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_Rn5s tabs__item--active">Python<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_Rn5s">Ruby</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Jyrm><div class="language-python codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-python codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">APPEND_PARAMETER ITEM1 </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> UINT </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xFFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> GENERIC_WRITE_CONVERSION_START</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">int</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">value </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)">1.5</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"># Convert the value by a scale factor</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> GENERIC_WRITE_CONVERSION_END</span><br/></span></code></pre></div></div></div><div role=tabpanel class=tabItem_Jyrm hidden><div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ITEM1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xFFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_WRITE_CONVERSION_START</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">value </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)">1.5</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">to_i </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Convert the value by a scale factor</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">GENERIC_WRITE_CONVERSION_END</span><br/></span></code></pre></div></div></div></div></div>
|
|
133
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=generic_write_conversion_end>GENERIC_WRITE_CONVERSION_END<a href=#generic_write_conversion_end class=hash-link aria-label="Direct link to GENERIC_WRITE_CONVERSION_END" title="Direct link to GENERIC_WRITE_CONVERSION_END" translate=no></a></h4>
|
|
134
134
|
<p><strong>Complete a generic write conversion</strong></p>
|
|
135
|
-
<h4 class="anchor
|
|
135
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=overflow>OVERFLOW<a href=#overflow class=hash-link aria-label="Direct link to OVERFLOW" title="Direct link to OVERFLOW" translate=no></a></h4>
|
|
136
136
|
<p><strong>Set the behavior when writing a value overflows the type</strong></p>
|
|
137
137
|
<p>By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be written, e.g. you can successfully write 255 to a 8 bit signed value.</p>
|
|
138
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Behavior<td>How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.<br
|
|
138
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Behavior<td>How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.<br/><br/>Valid Values: <span class=values>ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE</span><td>True</table>
|
|
139
139
|
<p>Example Usage:</p>
|
|
140
|
-
<div class="language-ruby
|
|
141
|
-
<h4 class="anchor
|
|
140
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">OVERFLOW</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUNCATE</span><br/></span></code></pre></div></div>
|
|
141
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=hidden>HIDDEN<a href=#hidden class=hash-link aria-label="Direct link to HIDDEN" title="Direct link to HIDDEN" translate=no></a></h4>
|
|
142
142
|
<p><strong>Indicates that the parameter should not be shown to the user in the Table Manager GUI</strong></p>
|
|
143
143
|
<p>Hidden parameters still exist and will be saved to the resulting binary. This is useful for padding and other essential but non-user editable fields.</p>
|
|
144
|
-
<h4 class="anchor
|
|
144
|
+
<h4 class="anchor anchorWithStickyNavbar_TUrh" id=uneditable>UNEDITABLE<a href=#uneditable class=hash-link aria-label="Direct link to UNEDITABLE" title="Direct link to UNEDITABLE" translate=no></a></h4>
|
|
145
145
|
<p><strong>Indicates that the parameter should be shown to the user but not editable.</strong></p>
|
|
146
146
|
<p>Uneditable parameters are useful for control fields which the user may be interested in but should not be able to edit.</p>
|
|
147
|
-
<h3 class="anchor
|
|
147
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=append_parameter>APPEND_PARAMETER<a href=#append_parameter class=hash-link aria-label="Direct link to APPEND_PARAMETER" title="Direct link to APPEND_PARAMETER" translate=no></a></h3>
|
|
148
148
|
<p><strong>Defines a parameter in the current table</strong></p>
|
|
149
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the table.<td>True<tr><td>Bit Size<td>Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'.<td>True<tr><td>Data Type<td>Data Type of this parameter<br
|
|
149
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the parameter. Must be unique within the table.<td>True<tr><td>Bit Size<td>Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'.<td>True<tr><td>Data Type<td>Data Type of this parameter<br/><br/>Valid Values: <span class=values>INT, UINT, FLOAT, DERIVED, STRING, BLOCK</span><td>True</table>
|
|
150
150
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
151
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br
|
|
151
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Minimum Value<td>Minimum allowed value for this parameter<td>True<tr><td>Maximum Value<td>Maximum allowed value for this parameter<td>True<tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on <a href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a>.<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
152
152
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
153
|
-
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br
|
|
154
|
-
<h2 class="anchor
|
|
153
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default Value<td>Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value.<td>True<tr><td>Description<td>Description for this parameter which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data in this command is to be sent in Big Endian or Little Endian format<br/><br/>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>False</table>
|
|
154
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=select_table>SELECT_TABLE<a href=#select_table class=hash-link aria-label="Direct link to SELECT_TABLE" title="Direct link to SELECT_TABLE" translate=no></a></h2>
|
|
155
155
|
<p><strong>Select an existing table for editing, typically done to override an existing definition</strong></p>
|
|
156
156
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Table<td>The name of the existing table<td>True</table>
|
|
157
|
-
<h2 class="anchor
|
|
157
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=default>DEFAULT<a href=#default class=hash-link aria-label="Direct link to DEFAULT" title="Direct link to DEFAULT" translate=no></a></h2>
|
|
158
158
|
<p><strong>Specify default values for a SINGLE row in a multi-column table</strong></p>
|
|
159
159
|
<p>If you have multiple rows you need a DEFAULT line for each row. If all your rows are identical consider using ERB as shown in the OpenC3 demo.</p>
|
|
160
160
|
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Default values<td>A STATE value or data value corresponding to the data type<td>False</table>
|
|
161
|
-
<h2 class="anchor
|
|
161
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=example-file>Example File<a href=#example-file class=hash-link aria-label="Direct link to Example File" title="Direct link to Example File" translate=no></a></h2>
|
|
162
162
|
<p><strong>Example File: TARGET/tables/config/MCConfigurationTable_def.txt</strong></p>
|
|
163
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TABLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"MC_Configuration"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY_VALUE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Memory Control Configuration Table"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_1_Start_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_1_End_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_2_Start_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_2_End_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFF</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Dump_Packet_Throttle_(sec)"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0FFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Number of seconds to wait between dumping large packets"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Memory_Scrubbing"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"SIOC_Memory_Config"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_Text"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_State"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_Check"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNCHECKED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CHECKED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Binary"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Binary string"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Pad"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HIDDEN</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/table.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/limits-response><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Limits Response</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/telemetry-screens><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Screens</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=#table-definition-files class="table-of-contents__link toc-highlight">Table Definition Files</a><li><a href=#tablefile class="table-of-contents__link toc-highlight">TABLEFILE</a><li><a href=#table class="table-of-contents__link toc-highlight">TABLE</a><li><a href=#table-modifiers class="table-of-contents__link toc-highlight">TABLE Modifiers</a><ul><li><a href=#parameter class="table-of-contents__link toc-highlight">PARAMETER</a><li><a href=#parameter-modifiers class="table-of-contents__link toc-highlight">PARAMETER Modifiers</a><ul><li><a href=#format_string class="table-of-contents__link toc-highlight">FORMAT_STRING</a><li><a href=#units class="table-of-contents__link toc-highlight">UNITS</a><li><a href=#description class="table-of-contents__link toc-highlight">DESCRIPTION</a><li><a href=#meta class="table-of-contents__link toc-highlight">META</a><li><a href=#overlap class="table-of-contents__link toc-highlight">OVERLAP</a><li><a href=#key class="table-of-contents__link toc-highlight">KEY</a><li><a href=#variable_bit_size class="table-of-contents__link toc-highlight">VARIABLE_BIT_SIZE</a><li><a href=#obfuscate class="table-of-contents__link toc-highlight">OBFUSCATE</a><li><a href=#required class="table-of-contents__link toc-highlight">REQUIRED</a><li><a href=#minimum_value class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a><li><a href=#maximum_value class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a><li><a href=#default_value class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a><li><a href=#state class="table-of-contents__link toc-highlight">STATE</a><li><a href=#write_conversion class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a><li><a href=#poly_write_conversion class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a><li><a href=#seg_poly_write_conversion class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a><li><a href=#generic_write_conversion_start class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a><li><a href=#generic_write_conversion_end class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a><li><a href=#overflow class="table-of-contents__link toc-highlight">OVERFLOW</a><li><a href=#hidden class="table-of-contents__link toc-highlight">HIDDEN</a><li><a href=#uneditable class="table-of-contents__link toc-highlight">UNEDITABLE</a></ul><li><a href=#append_parameter class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a></ul><li><a href=#select_table class="table-of-contents__link toc-highlight">SELECT_TABLE</a><li><a href=#default class="table-of-contents__link toc-highlight">DEFAULT</a><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
|
163
|
+
<div class="language-ruby codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-ruby codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">TABLE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"MC_Configuration"</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">KEY_VALUE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Memory Control Configuration Table"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_1_Start_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_1_End_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFFF</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_2_Start_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFB</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Scrub_Region_2_End_Addr"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x03FFFFF</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Dump_Packet_Throttle_(sec)"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0x0FFFFFFFF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Number of seconds to wait between dumping large packets"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Memory_Scrubbing"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"SIOC_Memory_Config"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_Text"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FORMAT_STRING</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"0x%0X"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_State"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DISABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ENABLE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable_Check"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MIN</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MAX</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Uneditable field"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNCHECKED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CHECKED</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UNEDITABLE</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Binary"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">STRING</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0xDEADBEEF</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Binary string"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_PARAMETER</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Pad"</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HIDDEN</span><br/></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/table.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/limits-response><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Limits Response</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/telemetry-screens><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Screens</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#table-definition-files class="table-of-contents__link toc-highlight">Table Definition Files</a><li><a href=#tablefile class="table-of-contents__link toc-highlight">TABLEFILE</a><li><a href=#table class="table-of-contents__link toc-highlight">TABLE</a><li><a href=#table-modifiers class="table-of-contents__link toc-highlight">TABLE Modifiers</a><ul><li><a href=#parameter class="table-of-contents__link toc-highlight">PARAMETER</a><li><a href=#parameter-modifiers class="table-of-contents__link toc-highlight">PARAMETER Modifiers</a><ul><li><a href=#format_string class="table-of-contents__link toc-highlight">FORMAT_STRING</a><li><a href=#units class="table-of-contents__link toc-highlight">UNITS</a><li><a href=#description class="table-of-contents__link toc-highlight">DESCRIPTION</a><li><a href=#meta class="table-of-contents__link toc-highlight">META</a><li><a href=#overlap class="table-of-contents__link toc-highlight">OVERLAP</a><li><a href=#key class="table-of-contents__link toc-highlight">KEY</a><li><a href=#variable_bit_size class="table-of-contents__link toc-highlight">VARIABLE_BIT_SIZE</a><li><a href=#obfuscate class="table-of-contents__link toc-highlight">OBFUSCATE</a><li><a href=#required class="table-of-contents__link toc-highlight">REQUIRED</a><li><a href=#minimum_value class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a><li><a href=#maximum_value class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a><li><a href=#default_value class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a><li><a href=#state class="table-of-contents__link toc-highlight">STATE</a><li><a href=#write_conversion class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a><li><a href=#poly_write_conversion class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a><li><a href=#seg_poly_write_conversion class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a><li><a href=#generic_write_conversion_start class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a><li><a href=#generic_write_conversion_end class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a><li><a href=#overflow class="table-of-contents__link toc-highlight">OVERFLOW</a><li><a href=#hidden class="table-of-contents__link toc-highlight">HIDDEN</a><li><a href=#uneditable class="table-of-contents__link toc-highlight">UNEDITABLE</a></ul><li><a href=#append_parameter class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a></ul><li><a href=#select_table class="table-of-contents__link toc-highlight">SELECT_TABLE</a><li><a href=#default class="table-of-contents__link toc-highlight">DEFAULT</a><li><a href=#example-file class="table-of-contents__link toc-highlight">Example File</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|