openc3-cosmos-tool-docs 5.20.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +1 -13
- data/tools/staticdocs/assets/css/styles.839a3ee9.css +1 -0
- data/tools/staticdocs/assets/images/add_tool-6919be6e6c05db133a8816a9fc03bf98b0789a8525da4cdaa7b041b25bf9edb8.png +0 -0
- data/tools/staticdocs/assets/images/array-c0c541246cb3f9e355acc5c510649c29116ce4d6eb8864b9ace48e9958b36421.png +0 -0
- data/tools/staticdocs/assets/images/backcolor-39ca0e2a25bd98fe1c9e067f026f3a719a760d3f14ccb404e2da3a0af4235760.png +0 -0
- data/tools/staticdocs/assets/images/block-14583c7d26c1a1c6553435d57015bc5282426f7aa176804867de223009a8d4d7.png +0 -0
- data/tools/staticdocs/assets/images/bordercolor-a3ac15f24f91c910fcc9c8bd195232205ec44da0b428b11b71108687ce6316d3.png +0 -0
- data/tools/staticdocs/assets/images/button-3f6fd69518f4b2c60b15605ca607cda8b596d4d5e804b867f09f750a47b6cbad.png +0 -0
- data/tools/staticdocs/assets/images/canvasdot-d634bed1905d13b0da41200e62781cea6e012b5d68fc914f4c11f512c9c4f7fd.png +0 -0
- data/tools/staticdocs/assets/images/canvasimage-6f6f83dc6d777fdff0b820287a96ad171a475fda2896c0a3b678b14984e496fd.png +0 -0
- data/tools/staticdocs/assets/images/canvasimagevalue-8c835310f99cebbb15ad34632c77370cf4cc9b95535040fa4723df8baedb5b57.png +0 -0
- data/tools/staticdocs/assets/images/canvaslabel-68ee99da9ef15924a2b5b41c60ba7de47382d036eece57574411839ff5ec14e4.png +0 -0
- data/tools/staticdocs/assets/images/canvaslabelvalue-43254b6647e626939e79ec7e0940e921582039af006e5024c952881ba196b165.png +0 -0
- data/tools/staticdocs/assets/images/canvasline-c5120da84530d4a60a04d40d5565daede656639808d1a456f430e9404a2d5bad.png +0 -0
- data/tools/staticdocs/assets/images/canvaslinevalue-5540d10997f723fd09b269b75997452622a3c4333ed4f25628747c1212699255.png +0 -0
- data/tools/staticdocs/assets/images/checkbutton-c263b840dcdbeca5cd886884fe8f24bedac7daac5a0ca224a1fb2cce3e24bdf6.png +0 -0
- data/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
- data/tools/staticdocs/assets/images/collect_states-5418d5b4cb901577f2cbdeccceb254dd2e5b81b1f2c975fb15b5fc679cf23dbf.png +0 -0
- data/tools/staticdocs/assets/images/combobox-6c8fa241aa7c5ccf31a42a2373dbd4f6f66d9a063e98ba111d5472b5c8e21590.png +0 -0
- data/tools/staticdocs/assets/images/command_history-ecc9b618661ad0aefa0700047a8ab3b094372f2aa427e9fcd270dcd352a30408.png +0 -0
- data/tools/staticdocs/assets/images/command_sender-83cf2e2343133c2883c405abd0b322f6d3d4a095c6ee800158a04c8eefe474ed.png +0 -0
- data/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png +0 -0
- data/tools/staticdocs/assets/images/date-d104f822ef7a1b99ade0a334e2e34c27fc6b1d087ed267f13280623a943113ce.png +0 -0
- data/tools/staticdocs/assets/images/formatvalue-8e2ddb6cec177fde1846d333d70168479a3bf67dd2b293764f938726b9e7cdf8.png +0 -0
- data/tools/staticdocs/assets/images/height-67268e562da2f9b2d0b9adc38d8fb2ba629504b09d798d8c26be9cfbfdad672a.png +0 -0
- data/tools/staticdocs/assets/images/history-04aebef1a0fdaaacc5042e5b835f850b48ea04f4fe50271d9bb57803b442d6cd.png +0 -0
- data/tools/staticdocs/assets/images/horizontal-11de51b6fc8baf057ca4f38a7f54a5302b58f30099331c22a074f012e53497aa.png +0 -0
- data/tools/staticdocs/assets/images/horizontalbox-ddf82f64de700286a742a71e0c1adebbc7e9822a0dff41139f41bc476e4fc4ce.png +0 -0
- data/tools/staticdocs/assets/images/horizontalline-0805762eadcc125ed6584a29a60e7cf8e2d76d13c6243e18eecbaba7a3803128.png +0 -0
- data/tools/staticdocs/assets/images/iframe-30d5a4104336b84d18ba538d668978a7986679431a7fe1fd0e3179fea08c074f.png +0 -0
- data/tools/staticdocs/assets/images/imageviewer-6149159e29a35cd6694926b344836ce034ce17cc019537028a80d95460eec405.png +0 -0
- data/tools/staticdocs/assets/images/inst_clear-48f37464d774363be4a5c1d30a48d4bc7803cb806a15d80dcd3741d7a9a37811.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect-ef36e8a1e97fde625cde7a9c300c3db61aca30140f5431f089ce6a3e5da9d7f4.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous-02857bda2b5e7e821d3f42d3301962ede2bb4379c469a9d62f4a0e686336f0c4.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-fa10646a27eb9045b70c2c485498a864bed1896ff171b7f31f8698288e08ae73.png +0 -0
- data/tools/staticdocs/assets/images/label-25a3052a497d0db7ebf84c788baedcd01d34f4b423aceee53d6d83639a128e82.png +0 -0
- data/tools/staticdocs/assets/images/labelled-b8d0f0a157f48e1fa98511f9177f962e69d1e0e8c24b37cf9f355671f9d13ab8.png +0 -0
- data/tools/staticdocs/assets/images/labelprogressbar-c3412db92b2f4e6af20233b085ee20915414d6c4da371398a3e8f36b84971cc7.png +0 -0
- data/tools/staticdocs/assets/images/labelsparkline-5985a0f034a5d2fb54b040612178ac9f0d5476eb76ca7e04cacc2618a9970c69.png +0 -0
- data/tools/staticdocs/assets/images/labelvalue-db97724272df4815b4ecc397974f91a62c31108b98ef0657716c670ca8128051.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluedesc-2e174a9f3443ba971683dea9a33f8aa66d0248fb92a3aff41ec26b7424b5e68c.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluelimitscolumn-47664affa9d88150ce257e90d32c61b314d7f0b6aa6da4f5e49152be2cce4ef7.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluerangebar-641eba160b8ef7872557584de92f046d9e4411fae3280781f9b049265cc6dd52.png +0 -0
- data/tools/staticdocs/assets/images/led-d333a6c7e8b1bad13b7775142c74f94b1829ddedd38814d606b2d00e76707751.png +0 -0
- data/tools/staticdocs/assets/images/limitsbar-4f2758f846f6f8a1add81aeaf3b58e071792a6d2ccae9eb504e9c07ab8f8dae1.png +0 -0
- data/tools/staticdocs/assets/images/limitscolor-7f8e24e4f27f476c3b4c57393ab797268b86aa8ad8b6e7b83d72dd5bf3ca7952.png +0 -0
- data/tools/staticdocs/assets/images/limitscolumn-743800180e9558c86a4f5c5d949e2b8355420a98c85ef98a3320b09defa21fe6.png +0 -0
- data/tools/staticdocs/assets/images/linegraph-dc3cca59601beb3ea551bbd05e4e09b6cfabd1a7cbc93b757a7d4b22c478a75b.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-6da2901ac63928daa3dcaf39a78ca9e455482c48d4ba917ee704f697e5210818.png +0 -0
- data/tools/staticdocs/assets/images/margin-4247b51c2c305cb961d08a807f30883b7fc6d9e3316c18174b86afe2356106dd.png +0 -0
- data/tools/staticdocs/assets/images/matrixbycolumns-74a67f236a97fffbdf7251fc98da2302a92df20ad16793a1617bc6f77380c9f6.png +0 -0
- data/tools/staticdocs/assets/images/microservices-805cc7d137958ac8183579cdb9a9845e7aef79db19723f0773f4ea4d957b48a1.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-04b9187b57a09ed12481a2699a86c7504fdc1c822579b4f762865ea90cb52dd3.png +0 -0
- data/tools/staticdocs/assets/images/named_widget-37362db8e310e5639be849d729fd637677f72330d676da4cd6baafc4b961331c.png +0 -0
- data/tools/staticdocs/assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png +0 -0
- data/tools/staticdocs/assets/images/padding-e8ceea8ec79def3b14d186971854c44883675d974409366b77c586eedd85025c.png +0 -0
- data/tools/staticdocs/assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png +0 -0
- data/tools/staticdocs/assets/images/progressbar-cc1095369de0d483c4a9b07ad3a76f9e966990b2aa68b2bc8177d7130ed382a7.png +0 -0
- data/tools/staticdocs/assets/images/radiobutton-9151f7cb0dae5120e51e05b5575981c143e19f350e84c7e190d3dd78aa80fae8.png +0 -0
- data/tools/staticdocs/assets/images/rangebar-ceae5a30609ab12625e29fd479e88fb3ba16eb12879976edc807da87547a275d.png +0 -0
- data/tools/staticdocs/assets/images/raw-63c1dd793f4a734e7d512bf4c0c3722831c38d5392a1a1b0cb77bbef4d16b96b.png +0 -0
- data/tools/staticdocs/assets/images/redis-4553b5b35292cca3df1fa08577f2175efef34e0fdfe512f30ca70785b086b24f.png +0 -0
- data/tools/staticdocs/assets/images/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png +0 -0
- data/tools/staticdocs/assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png +0 -0
- data/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png +0 -0
- data/tools/staticdocs/assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png +0 -0
- data/tools/staticdocs/assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png +0 -0
- data/tools/staticdocs/assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png +0 -0
- data/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png +0 -0
- data/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png +0 -0
- data/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png +0 -0
- data/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png +0 -0
- data/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png +0 -0
- data/tools/staticdocs/assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png +0 -0
- data/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png +0 -0
- data/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png +0 -0
- data/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png +0 -0
- data/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png +0 -0
- data/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png +0 -0
- data/tools/staticdocs/assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png +0 -0
- data/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png +0 -0
- data/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png +0 -0
- data/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png +0 -0
- data/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png +0 -0
- data/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png +0 -0
- data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
- data/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.8413befc.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.a4ceeb8e.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ae0a89e8.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.90ef4019.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.1c827de2.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.3b7f9c95.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.76716a45.js +1 -0
- data/tools/staticdocs/assets/js/13196248.18801ae0.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.4457fa9a.js +1 -0
- data/tools/staticdocs/assets/js/1602.1e622848.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.8e63f255.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.9470f5c9.js +1 -0
- data/tools/staticdocs/assets/js/2124.0e1f26f5.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.ac895789.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.45d268b1.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.471e10a1.js +1 -0
- data/tools/staticdocs/assets/js/3040.18a0bb2a.js +4 -0
- data/tools/staticdocs/assets/js/3687.6fa52db1.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.d8bb37a8.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.5f8a5da7.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.c8f67fde.js +1 -0
- data/tools/staticdocs/assets/js/42170351.86617d4a.js +1 -0
- data/tools/staticdocs/assets/js/4303.a84f454a.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.0c473c25.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.f0e35da3.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.9ace531c.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.565c0c28.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.80b7b43c.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.ed839e0d.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.048e258b.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.96109971.js +1 -0
- data/tools/staticdocs/assets/js/62df909c.dd5f3a0c.js +1 -0
- data/tools/staticdocs/assets/js/630e5448.699a9dec.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.4008a669.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.34aa1d77.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d37e3087.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.f71c0e94.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.c98e31e0.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.1053fbd7.js +1 -0
- data/tools/staticdocs/assets/js/75897369.522ccdd7.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.6b588c87.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7f5b2696.72e3b019.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.5a408d9c.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.866fe67b.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.b4e9da15.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.59da8025.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.cc8aa06e.js +1 -0
- data/tools/staticdocs/assets/js/97535711.94a5b402.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.ebea1d08.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.4bc52207.js +1 -0
- data/tools/staticdocs/assets/js/{9fb6059a.a5107afb.js → 9fb6059a.57936fbe.js} +1 -1
- data/tools/staticdocs/assets/js/a677c089.d8d7a8f5.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.2aa836fd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.4f484861.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.a5fe2cea.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5df56282.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.cdb4a698.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.5fb449fc.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.f419c8fb.js +1 -0
- data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +1 -0
- data/tools/staticdocs/assets/js/c5388ca4.32f8f561.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.9264e5dd.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.aa3c877c.js +1 -0
- data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.de9e8fd6.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.82dd17ab.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.1cb515f4.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.09769a64.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1704d750.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.1861d710.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js +1 -0
- data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js +1 -0
- data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.fa25adc4.js +1 -0
- data/tools/staticdocs/assets/js/main.1a59b278.js +36 -0
- data/tools/staticdocs/assets/js/runtime~main.25e99a76.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +85 -0
- data/tools/staticdocs/docs/configuration/command.html +148 -160
- data/tools/staticdocs/docs/configuration/format.html +28 -40
- data/tools/staticdocs/docs/configuration/interfaces.html +119 -64
- data/tools/staticdocs/docs/configuration/plugins.html +234 -225
- data/tools/staticdocs/docs/configuration/protocols.html +106 -92
- data/tools/staticdocs/docs/configuration/ssl-tls.html +34 -46
- data/tools/staticdocs/docs/configuration/table.html +88 -100
- data/tools/staticdocs/docs/configuration/target.html +29 -41
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +368 -322
- data/tools/staticdocs/docs/configuration/telemetry.html +136 -142
- data/tools/staticdocs/docs/configuration.html +1 -13
- data/tools/staticdocs/docs/development/curl.html +17 -29
- data/tools/staticdocs/docs/development/developing.html +24 -36
- data/tools/staticdocs/docs/development/json-api.html +26 -38
- data/tools/staticdocs/docs/development/log-structure.html +19 -31
- data/tools/staticdocs/docs/development/roadmap.html +26 -44
- data/tools/staticdocs/docs/development/streaming-api.html +10 -22
- data/tools/staticdocs/docs/development/testing.html +23 -27
- data/tools/staticdocs/docs/development.html +1 -13
- data/tools/staticdocs/docs/getting-started/generators.html +37 -49
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +45 -56
- data/tools/staticdocs/docs/getting-started/installation.html +24 -36
- data/tools/staticdocs/docs/getting-started/key_concepts.html +32 -44
- data/tools/staticdocs/docs/getting-started/podman.html +25 -37
- data/tools/staticdocs/docs/getting-started/requirements.html +32 -44
- data/tools/staticdocs/docs/getting-started/upgrading.html +134 -24
- data/tools/staticdocs/docs/getting-started.html +1 -13
- data/tools/staticdocs/docs/guides/bridges.html +17 -30
- data/tools/staticdocs/docs/guides/cfs.html +46 -58
- data/tools/staticdocs/docs/guides/custom-widgets.html +17 -29
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -15
- data/tools/staticdocs/docs/guides/local-mode.html +16 -28
- data/tools/staticdocs/docs/guides/logging.html +12 -24
- data/tools/staticdocs/docs/guides/monitoring.html +18 -30
- data/tools/staticdocs/docs/guides/performance.html +21 -33
- data/tools/staticdocs/docs/guides/raspberrypi.html +16 -28
- data/tools/staticdocs/docs/guides/script-writing.html +108 -120
- data/tools/staticdocs/docs/guides/scripting-api.html +606 -615
- data/tools/staticdocs/docs/guides.html +1 -13
- data/tools/staticdocs/docs/meta/contributing.html +14 -26
- data/tools/staticdocs/docs/meta/licenses.html +36 -25
- data/tools/staticdocs/docs/meta/philosophy.html +3 -15
- data/tools/staticdocs/docs/meta/xtce.html +13 -25
- data/tools/staticdocs/docs/meta.html +1 -13
- data/tools/staticdocs/docs/privacy.html +19 -31
- data/tools/staticdocs/docs/tools/admin.html +36 -0
- data/tools/staticdocs/docs/tools/autonomic.html +22 -34
- data/tools/staticdocs/docs/tools/bucket-explorer.html +10 -22
- data/tools/staticdocs/docs/tools/calendar.html +21 -33
- data/tools/staticdocs/docs/tools/cmd-sender.html +16 -28
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +27 -36
- data/tools/staticdocs/docs/tools/command_history.html +10 -0
- data/tools/staticdocs/docs/tools/data-extractor.html +29 -41
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -23
- data/tools/staticdocs/docs/tools/handbooks.html +4 -16
- data/tools/staticdocs/docs/tools/limits-monitor.html +18 -30
- data/tools/staticdocs/docs/tools/packet-viewer.html +16 -28
- data/tools/staticdocs/docs/tools/script-runner.html +43 -55
- data/tools/staticdocs/docs/tools/table-manager.html +16 -28
- data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -33
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -28
- data/tools/staticdocs/docs/tools.html +1 -13
- data/tools/staticdocs/docs.html +12 -24
- data/tools/staticdocs/img/admin/add_tool.png +0 -0
- data/tools/staticdocs/img/admin/interfaces.png +0 -0
- data/tools/staticdocs/img/admin/microservices.png +0 -0
- data/tools/staticdocs/img/admin/packages.png +0 -0
- data/tools/staticdocs/img/admin/plugins.png +0 -0
- data/tools/staticdocs/img/admin/redis.png +0 -0
- data/tools/staticdocs/img/admin/routers.png +0 -0
- data/tools/staticdocs/img/admin/secrets.png +0 -0
- data/tools/staticdocs/img/admin/settings1.png +0 -0
- data/tools/staticdocs/img/admin/settings2.png +0 -0
- data/tools/staticdocs/img/admin/targets.png +0 -0
- data/tools/staticdocs/img/admin/tools.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_authority.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/critical_cmd_sender.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
- data/tools/staticdocs/img/command_history/command_history.png +0 -0
- data/tools/staticdocs/img/command_sender/collect_states.png +0 -0
- data/tools/staticdocs/img/command_sender/command_sender.png +0 -0
- data/tools/staticdocs/img/command_sender/history.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_clear.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_collect.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_collect_hazardous.png +0 -0
- data/tools/staticdocs/img/command_sender/mode_menu.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/array.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/backcolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/block.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/bordercolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/button.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasdot.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimage.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimagevalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabel.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabelvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslinevalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/checkbutton.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/combobox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/date.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/formatvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/height.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontal.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/iframe.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/imageviewer.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/label.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelled.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelprogressbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelsparkline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluedesc.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluelimitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluerangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/led.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitsbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/linegraph.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/margin.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/matrixbycolumns.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/named_widget.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/padding.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/progressbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/radiobutton.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/rangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/raw.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/rollup.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/scrollwindow.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/signal.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/spacer.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/sparkline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/subsetting.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/tabbook.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/tabitem.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textcolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textfield.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/time.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/title.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/value.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitsbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuerangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/vertical.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/width.png +0 -0
- data/tools/staticdocs/index.html +1 -13
- data/tools/staticdocs/lunr-index-1734474862542.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +2 -14
- data/tools/staticdocs/search-doc-1734474862542.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +254 -99
- data/tools/staticdocs/assets/css/styles.80ddca08.css +0 -1
- data/tools/staticdocs/assets/images/cmd_authority-51594401bfa6d8cc5849aae05b4d2af838360f8a3329f9746aa1307fe3091402.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-727ea478568988b10e4be4a3ba7255dd48ec56f6ab6444c6c1e32497fe478681.png +0 -0
- data/tools/staticdocs/assets/images/collect_states-565ae4b6d02449850585afd7ce35982711d4d677f5a04c1332b2c176f1ec3a25.png +0 -0
- data/tools/staticdocs/assets/images/command_sender-bb1543bde21fc1963405de5251d16a80a0c3a1bf5adb5fb78145d4995e2fe541.png +0 -0
- data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
- data/tools/staticdocs/assets/images/inst_clear-2d5f985c879e8b917fedacdb8c6552bbd383231bf5c8ab8e560e77df4e050026.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect-81bc422b3b33c5ebcbe4c2f489c730b32ab0d6ea6c7f81cc79d9f6bc03e9db15.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous-a8fb19ea296354a0cd276da1e0ad82f74479eea4e7e204fcf64b779596f2c092.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.727d87f1.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.f2d69d72.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.83641127.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.017a0733.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.aa4daee5.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.537144c5.js +0 -1
- data/tools/staticdocs/assets/js/13196248.6b49e93d.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.22a0b1d4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.0445f325.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.25d11993.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +0 -1
- data/tools/staticdocs/assets/js/2601.ca992ab9.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.633f7a6c.js +0 -1
- data/tools/staticdocs/assets/js/3917.a6366d59.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.d55880a8.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.4b4b2ccd.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.1d6a609d.js +0 -1
- data/tools/staticdocs/assets/js/42170351.d7f6034b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.fa34b0b0.js +0 -1
- data/tools/staticdocs/assets/js/5723.f6123e37.js +0 -1
- data/tools/staticdocs/assets/js/5778.7d36f1c2.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.6fdd6b6c.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.daa2a049.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.61a9cae2.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.0b54b37a.js +0 -1
- data/tools/staticdocs/assets/js/62df909c.906d9999.js +0 -1
- data/tools/staticdocs/assets/js/630e5448.6fea087c.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.60c3c6d5.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.a5ae3d65.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.aaa91da1.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.76b83e83.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.d02304f0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.98821dd1.js +0 -1
- data/tools/staticdocs/assets/js/75897369.7b31b03e.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.6ef0928b.js +0 -1
- data/tools/staticdocs/assets/js/7760.7f593c4f.js +0 -2
- data/tools/staticdocs/assets/js/7760.7f593c4f.js.LICENSE.txt +0 -61
- data/tools/staticdocs/assets/js/7f5b2696.60735273.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.48133ad5.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.13ce283b.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.7a68246a.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.b6a7e150.js +0 -1
- data/tools/staticdocs/assets/js/97535711.5311ddd9.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.64e9c551.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +0 -1
- data/tools/staticdocs/assets/js/a507c363.d2cc5d72.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.7877e85d.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.0358fb0b.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.9f3252e1.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.daa24b72.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.19c327f0.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.6691ccc4.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.503774e8.js +0 -1
- data/tools/staticdocs/assets/js/c2598f55.c5a1bac3.js +0 -1
- data/tools/staticdocs/assets/js/c5388ca4.f526bb0c.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.b82ad06f.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.f956406f.js +0 -1
- data/tools/staticdocs/assets/js/ce89ef36.aa518a52.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.28d99aa4.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.6c422113.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.8f23a506.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.fb296e02.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.2349d796.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.8f82360d.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.b0500934.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.e3a82d1e.js +0 -1
- data/tools/staticdocs/assets/js/dfbae5fd.d1484e14.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.0b407477.js +0 -1
- data/tools/staticdocs/assets/js/ebec1ccb.a1b5fc97.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.ee14b7d6.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.4a41fa80.js +0 -1
- data/tools/staticdocs/assets/js/main.03e795fe.js +0 -2
- data/tools/staticdocs/assets/js/main.03e795fe.js.LICENSE.txt +0 -71
- data/tools/staticdocs/assets/js/runtime~main.cb8e940d.js +0 -1
- data/tools/staticdocs/docs/development/host-install.html +0 -38
- data/tools/staticdocs/docs/v5/host-install/index.html +0 -11
- data/tools/staticdocs/lunr-index-1730331075297.json +0 -1
- data/tools/staticdocs/search-doc-1730331075297.json +0 -1
|
@@ -1,172 +1,160 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<
|
|
3
|
-
<
|
|
4
|
-
<
|
|
5
|
-
<
|
|
6
|
-
<title data-rh="true">Tables | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/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 Files"><meta data-rh="true" property="og:description" content="Table Definition Files"><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"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.cb8e940d.js" defer="defer"></script>
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.03e795fe.js" defer="defer"></script>
|
|
9
|
-
</head>
|
|
10
|
-
<body class="navigation-with-keyboard">
|
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Tables</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>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>
|
|
12
|
-
<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>
|
|
13
|
-
. 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>
|
|
14
|
-
<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>
|
|
15
|
-
<div style="clear:both"></div>
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/table" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><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><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.25e99a76.js defer></script><script src=/tools/staticdocs/assets/js/main.1a59b278.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Collapse sidebar category 'Configuration'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/format>File Format</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/plugins>Plugins</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/target>Targets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/command>Commands</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link 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 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 itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Tables</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>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>
|
|
2
|
+
<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>
|
|
3
|
+
. 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>
|
|
4
|
+
<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>
|
|
5
|
+
<div style=clear:both></div>
|
|
16
6
|
<h1>Table Keywords</h1>
|
|
17
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
7
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=tablefile>TABLEFILE<a href=#tablefile class=hash-link aria-label="Direct link to TABLEFILE" title="Direct link to TABLEFILE"></a></h2>
|
|
18
8
|
<p><strong>Specify another file to open and process for table definitions</strong></p>
|
|
19
|
-
<table><thead><tr><th>Parameter
|
|
20
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
9
|
+
<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>
|
|
10
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=table>TABLE<a href=#table class=hash-link aria-label="Direct link to TABLE" title="Direct link to TABLE"></a></h2>
|
|
21
11
|
<p><strong>Start a new table definition</strong></p>
|
|
22
|
-
<table><thead><tr><th>Parameter
|
|
12
|
+
<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>
|
|
23
13
|
<p>When Display is KEY_VALUE the remaining parameters are:</p>
|
|
24
|
-
<table><thead><tr><th>Parameter
|
|
14
|
+
<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>
|
|
25
15
|
<p>When Display is ROW_COLUMN the remaining parameters are:</p>
|
|
26
|
-
<table><thead><tr><th>Parameter
|
|
27
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
16
|
+
<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>
|
|
17
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
28
18
|
<p>The following keywords must follow a TABLE keyword.</p>
|
|
29
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
19
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=parameter>PARAMETER<a href=#parameter class=hash-link aria-label="Direct link to PARAMETER" title="Direct link to PARAMETER"></a></h3>
|
|
30
20
|
<p><strong>Defines a parameter in the current table</strong></p>
|
|
31
|
-
<table><thead><tr><th>Parameter
|
|
21
|
+
<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 on 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>
|
|
32
22
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
33
|
-
<table><thead><tr><th>Parameter
|
|
23
|
+
<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>
|
|
34
24
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
35
|
-
<table><thead><tr><th>Parameter
|
|
36
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
25
|
+
<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>
|
|
26
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
37
27
|
<p>The following keywords must follow a PARAMETER keyword.</p>
|
|
38
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
28
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
39
29
|
<p><strong>Adds printf style formatting</strong></p>
|
|
40
|
-
<table><thead><tr><th>Parameter
|
|
30
|
+
<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>
|
|
41
31
|
<p>Example Usage:</p>
|
|
42
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
43
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
32
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
33
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=units>UNITS<a href=#units class=hash-link aria-label="Direct link to UNITS" title="Direct link to UNITS"></a></h4>
|
|
44
34
|
<p><strong>Add displayed units</strong></p>
|
|
45
|
-
<table><thead><tr><th>Parameter
|
|
35
|
+
<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>
|
|
46
36
|
<p>Example Usage:</p>
|
|
47
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
48
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
37
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
38
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=description>DESCRIPTION<a href=#description class=hash-link aria-label="Direct link to DESCRIPTION" title="Direct link to DESCRIPTION"></a></h4>
|
|
49
39
|
<p><strong>Override the defined description</strong></p>
|
|
50
|
-
<table><thead><tr><th>Parameter
|
|
51
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
40
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new description<td>True</table>
|
|
41
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=meta>META<a href=#meta class=hash-link aria-label="Direct link to META" title="Direct link to META"></a></h4>
|
|
52
42
|
<p><strong>Stores custom user metadata</strong></p>
|
|
53
43
|
<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>
|
|
54
|
-
<table><thead><tr><th>Parameter
|
|
44
|
+
<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>
|
|
55
45
|
<p>Example Usage:</p>
|
|
56
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
57
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
58
|
-
<p
|
|
59
|
-
<p>If an item
|
|
60
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
61
|
-
<p
|
|
62
|
-
<p>Keys are often
|
|
63
|
-
<table><thead><tr><th>Parameter
|
|
46
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
47
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=overlap>OVERLAP<a href=#overlap class=hash-link aria-label="Direct link to OVERLAP" title="Direct link to OVERLAP"></a></h4>
|
|
48
|
+
<p><div class=right>(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
|
49
|
+
<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>
|
|
50
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=key>KEY<a href=#key class=hash-link aria-label="Direct link to KEY" title="Direct link to KEY"></a></h4>
|
|
51
|
+
<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>
|
|
52
|
+
<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>
|
|
53
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key string<td>The key to access this item<td>True</table>
|
|
64
54
|
<p>Example Usage:</p>
|
|
65
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
66
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
67
|
-
<p
|
|
68
|
-
<table><thead><tr><th>Parameter
|
|
69
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
55
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
56
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
57
|
+
<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>
|
|
58
|
+
<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>
|
|
59
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=required>REQUIRED<a href=#required class=hash-link aria-label="Direct link to REQUIRED" title="Direct link to REQUIRED"></a></h4>
|
|
70
60
|
<p><strong>Parameter is required to be populated in scripts</strong></p>
|
|
71
61
|
<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>
|
|
72
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
62
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
73
63
|
<p><strong>Override the defined minimum value</strong></p>
|
|
74
|
-
<table><thead><tr><th>Parameter
|
|
75
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
64
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new minimum value for the parameter<td>True</table>
|
|
65
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
76
66
|
<p><strong>Override the defined maximum value</strong></p>
|
|
77
|
-
<table><thead><tr><th>Parameter
|
|
78
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
67
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new maximum value for the parameter<td>True</table>
|
|
68
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
79
69
|
<p><strong>Override the defined default value</strong></p>
|
|
80
|
-
<table><thead><tr><th>Parameter
|
|
81
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
70
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new default value for the parameter<td>True</table>
|
|
71
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=state>STATE<a href=#state class=hash-link aria-label="Direct link to STATE" title="Direct link to STATE"></a></h4>
|
|
82
72
|
<p><strong>Defines a key/value pair for the current command parameter</strong></p>
|
|
83
73
|
<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>
|
|
84
|
-
<table><thead><tr><th>Parameter
|
|
74
|
+
<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>
|
|
85
75
|
<p>Example Usage:</p>
|
|
86
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
87
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
76
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
77
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
88
78
|
<p><strong>Applies a conversion when writing the current command parameter</strong></p>
|
|
89
79
|
<p>Conversions are implemented in a custom Ruby or Python file which should be
|
|
90
|
-
located in the target
|
|
80
|
+
located in the target's lib folder. The class must inherit from Conversion.
|
|
91
81
|
It must implement the <code>initialize</code> (Ruby) or <code>__init__</code> (Python) method if it
|
|
92
82
|
takes extra parameters and must always implement the <code>call</code> method. The conversion
|
|
93
83
|
factor is applied to the value entered by the user before it is written into
|
|
94
84
|
the binary command packet and sent.</p>
|
|
95
|
-
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=
|
|
85
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_bl22><p>When a command is built, each item gets written (and write conversions are run)
|
|
96
86
|
to set the default value. Then items are written (again write conversions are run)
|
|
97
87
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
98
88
|
no guarantees which parameters have already been written. The packet itself has a
|
|
99
89
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
100
|
-
values to the command. That can be used to check parameter values passed in.</
|
|
101
|
-
<table><thead><tr><th>Parameter
|
|
90
|
+
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
91
|
+
<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'.<td>True<tr><td>Parameter<td>Additional parameter values for the conversion which are passed to the class constructor.<td>False</table>
|
|
102
92
|
<p>Ruby Example:</p>
|
|
103
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
93
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">WRITE_CONVERSION</span><span class="token plain"> the_great_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token number" style="color:rgb(247, 140, 108)">1000</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Defined </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> the_great_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></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)">require</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'openc3/conversions/conversion'</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)">module</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">OpenC3</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)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">TheGreatConversion</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain"> Conversion</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">initialize</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">multiplier</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">super</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@multiplier</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> multiplier</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">to_f</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token method-definition function" style="color:rgb(130, 170, 255)">call</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">value</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> buffer</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> value </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain"> multiplier</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">end</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
104
94
|
<p>Python Example:</p>
|
|
105
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
106
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
95
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">WRITE_CONVERSION the_great_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py </span><span class="token number" style="color:rgb(247, 140, 108)">1000</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Defined </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> the_great_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></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)">from</span><span class="token plain"> openc3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">conversions</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">conversion </span><span class="token keyword" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> Conversion</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)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">TheGreatConversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">Conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">__init__</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> multiplier</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">super</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 punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">__init__</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">multiplier </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">float</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">multiplier</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">call</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> value</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">buffer</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> value </span><span class="token operator" style="color:rgb(127, 219, 202)">*</span><span class="token plain"> self</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">multiplier</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
96
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
107
97
|
<p><strong>Adds a polynomial conversion factor to the current command parameter</strong></p>
|
|
108
98
|
<p>The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent.</p>
|
|
109
|
-
<table><thead><tr><th>Parameter
|
|
99
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>C0<td>Coefficient<td>True<tr><td>Cx<td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.<td>False</table>
|
|
110
100
|
<p>Example Usage:</p>
|
|
111
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
112
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
101
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.25</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
102
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
113
103
|
<p><strong>Adds a segmented polynomial conversion factor to the current command parameter</strong></p>
|
|
114
104
|
<p>This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent.</p>
|
|
115
|
-
<table><thead><tr><th>Parameter
|
|
105
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Lower Bound<td>Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound.<td>True<tr><td>C0<td>Coefficient<td>True<tr><td>Cx<td>Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate.<td>False</table>
|
|
116
106
|
<p>Example Usage:</p>
|
|
117
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
118
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
107
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">SEG_POLY_WRITE_CONVERSION</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)">10</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.25</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values < 50</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)">SEG_POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">50</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">11</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.275</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values >= 50 and < 100</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)">SEG_POLY_WRITE_CONVERSION</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">100</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.5</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.3</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Apply the conversion to all values >= 100</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
108
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
119
109
|
<p><strong>Start a generic write conversion</strong></p>
|
|
120
110
|
<p>Adds a generic conversion function to the current command parameter.
|
|
121
111
|
This conversion factor is applied to the value entered by the user before it
|
|
122
112
|
is written into the binary command packet and sent. The conversion is specified
|
|
123
|
-
as Ruby or Python code that receives two implied parameters.
|
|
124
|
-
value being written and
|
|
125
|
-
class (Note, referencing the packet as
|
|
113
|
+
as Ruby or Python code that receives two implied parameters. 'value' which is the raw
|
|
114
|
+
value being written and 'packet' which is a reference to the command packet
|
|
115
|
+
class (Note, referencing the packet as 'myself' is still supported for backwards
|
|
126
116
|
compatibility). The last line of code should return the converted
|
|
127
117
|
value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
|
|
128
118
|
code for the conversion have been given.</p>
|
|
129
|
-
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=
|
|
119
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Multiple write conversions on command parameters</div><div class=admonitionContent_bl22><p>When a command is built, each item gets written (and write conversions are run)
|
|
130
120
|
to set the default value. Then items are written (again write conversions are run)
|
|
131
121
|
with user provided values. Thus write conversions can be run twice. Also there are
|
|
132
122
|
no guarantees which parameters have already been written. The packet itself has a
|
|
133
123
|
given_values() method which can be used to retrieve a hash of the user provided
|
|
134
|
-
values to the command. That can be used to check parameter values passed in.</
|
|
135
|
-
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=
|
|
124
|
+
values to the command. That can be used to check parameter values passed in.</div></div>
|
|
125
|
+
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>warning</div><div class=admonitionContent_bl22><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>
|
|
136
126
|
<p>Ruby Example:</p>
|
|
137
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
127
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
138
128
|
<p>Python Example:</p>
|
|
139
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
140
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
129
|
+
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-python codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
130
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h4>
|
|
141
131
|
<p><strong>Complete a generic write conversion</strong></p>
|
|
142
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
132
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=overflow>OVERFLOW<a href=#overflow class=hash-link aria-label="Direct link to OVERFLOW" title="Direct link to OVERFLOW"></a></h4>
|
|
143
133
|
<p><strong>Set the behavior when writing a value overflows the type</strong></p>
|
|
144
|
-
<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
|
|
145
|
-
<table><thead><tr><th>Parameter
|
|
134
|
+
<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>
|
|
135
|
+
<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>
|
|
146
136
|
<p>Example Usage:</p>
|
|
147
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
148
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
137
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">OVERFLOW</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TRUNCATE</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
138
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=hidden>HIDDEN<a href=#hidden class=hash-link aria-label="Direct link to HIDDEN" title="Direct link to HIDDEN"></a></h4>
|
|
149
139
|
<p><strong>Indicates that the parameter should not be shown to the user in the Table Manager GUI</strong></p>
|
|
150
140
|
<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>
|
|
151
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
141
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=uneditable>UNEDITABLE<a href=#uneditable class=hash-link aria-label="Direct link to UNEDITABLE" title="Direct link to UNEDITABLE"></a></h4>
|
|
152
142
|
<p><strong>Indicates that the parameter should be shown to the user but not editable.</strong></p>
|
|
153
143
|
<p>Uneditable parameters are useful for control fields which the user may be interested in but should not be able to edit.</p>
|
|
154
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
144
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h3>
|
|
155
145
|
<p><strong>Defines a parameter in the current table</strong></p>
|
|
156
|
-
<table><thead><tr><th>Parameter
|
|
146
|
+
<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>
|
|
157
147
|
<p>When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:</p>
|
|
158
|
-
<table><thead><tr><th>Parameter
|
|
148
|
+
<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>
|
|
159
149
|
<p>When Data Type is STRING, BLOCK the remaining parameters are:</p>
|
|
160
|
-
<table><thead><tr><th>Parameter
|
|
161
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
150
|
+
<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>
|
|
151
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
162
152
|
<p><strong>Select an existing table for editing, typically done to override an existing definition</strong></p>
|
|
163
|
-
<table><thead><tr><th>Parameter
|
|
164
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
153
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Table<td>The name of the existing table<td>True</table>
|
|
154
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=default>DEFAULT<a href=#default class=hash-link aria-label="Direct link to DEFAULT" title="Direct link to DEFAULT"></a></h2>
|
|
165
155
|
<p><strong>Specify default values for a SINGLE row in a multi-column table</strong></p>
|
|
166
156
|
<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>
|
|
167
|
-
<table><thead><tr><th>Parameter
|
|
168
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
157
|
+
<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>
|
|
158
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" 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"></a></h2>
|
|
169
159
|
<p><strong>Example File: TARGET/tables/config/MCConfigurationTable_def.txt</strong></p>
|
|
170
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token constant" style="color:rgb(130, 170, 255)">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 class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></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"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/protocols"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Protocols</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><li><a href="#tablefile" class="table-of-contents__link toc-highlight">TABLEFILE</a></li><li><a href="#table" class="table-of-contents__link toc-highlight">TABLE</a></li><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><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><li><a href="#units" class="table-of-contents__link toc-highlight">UNITS</a></li><li><a href="#description" class="table-of-contents__link toc-highlight">DESCRIPTION</a></li><li><a href="#meta" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#overlap" class="table-of-contents__link toc-highlight">OVERLAP</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#variable_bit_size" class="table-of-contents__link toc-highlight">VARIABLE_BIT_SIZE</a></li><li><a href="#required" class="table-of-contents__link toc-highlight">REQUIRED</a></li><li><a href="#minimum_value" class="table-of-contents__link toc-highlight">MINIMUM_VALUE</a></li><li><a href="#maximum_value" class="table-of-contents__link toc-highlight">MAXIMUM_VALUE</a></li><li><a href="#default_value" class="table-of-contents__link toc-highlight">DEFAULT_VALUE</a></li><li><a href="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#write_conversion" class="table-of-contents__link toc-highlight">WRITE_CONVERSION</a></li><li><a href="#poly_write_conversion" class="table-of-contents__link toc-highlight">POLY_WRITE_CONVERSION</a></li><li><a href="#seg_poly_write_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_WRITE_CONVERSION</a></li><li><a href="#generic_write_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_START</a></li><li><a href="#generic_write_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_WRITE_CONVERSION_END</a></li><li><a href="#overflow" class="table-of-contents__link toc-highlight">OVERFLOW</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#uneditable" class="table-of-contents__link toc-highlight">UNEDITABLE</a></li></ul></li><li><a href="#append_parameter" class="table-of-contents__link toc-highlight">APPEND_PARAMETER</a></li></ul></li><li><a href="#select_table" class="table-of-contents__link toc-highlight">SELECT_TABLE</a></li><li><a href="#default" class="table-of-contents__link toc-highlight">DEFAULT</a></li><li><a href="#example-file" class="table-of-contents__link toc-highlight">Example File</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
|
171
|
-
</body>
|
|
172
|
-
</html>
|
|
160
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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 class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div></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="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/configuration/accessors><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Accessors</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=#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="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|