openc3-cosmos-tool-docs 5.19.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- 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/right_click-371e3683026c0bb2b27187277b4e99727c6b52965e0190a5f81335248f40ef9b.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 +149 -158
- 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 +374 -316
- 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 +44 -50
- 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/script_runner/right_click.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 +256 -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.9d01fab0.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.be25aaac.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.ea51e6e5.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.a3784266.js +0 -2
- data/tools/staticdocs/assets/js/main.a3784266.js.LICENSE.txt +0 -71
- data/tools/staticdocs/assets/js/runtime~main.9f7e4d76.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-1727813111453.json +0 -1
- data/tools/staticdocs/search-doc-1727813111453.json +0 -1
|
@@ -1,218 +1,212 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="generator" content="Docusaurus v3.5.2">
|
|
6
|
-
<title data-rh="true">Telemetry | 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/telemetry"><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="Telemetry | OpenC3 Docs"><meta data-rh="true" name="description" content="Telemetry Definition Files"><meta data-rh="true" property="og:description" content="Telemetry 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/telemetry"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
|
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js" defer="defer"></script>
|
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.a3784266.js" defer="defer"></script>
|
|
9
|
-
</head>
|
|
10
|
-
<body class="navigation-with-keyboard">
|
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category '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 menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category '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">Telemetry</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>Telemetry</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="telemetry-definition-files">Telemetry Definition Files<a href="#telemetry-definition-files" class="hash-link" aria-label="Direct link to Telemetry Definition Files" title="Direct link to Telemetry Definition Files"></a></h2>
|
|
12
|
-
<p>Telemetry definition files define the telemetry packets that can be received and processed from COSMOS targets. One large file can be used to define the telemetry packets, or multiple files can be used at the user's discretion. Telemetry definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some telemetry files that depend on others, e.g. they override or extend existing telemetry, they must be named last. The easiest way to do this is to add an extension to an existing file name. For example, if you already have tlm.txt you can create tlm_override.txt for telemetry that depends on the definitions in tlm.txt. Note that due to the way the <a href="http://www.asciitable.com/" target="_blank" rel="noopener noreferrer">ASCII Table</a> is structured, files beginning with capital letters are processed before lower case letters.</p>
|
|
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/telemetry" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Telemetry | 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/telemetry><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="Telemetry | OpenC3 Docs"><meta data-rh=true name=description content="Telemetry definition file format and keywords"><meta data-rh=true property=og:description content="Telemetry 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/telemetry><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/configuration/telemetry 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 menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry>Telemetry</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/interfaces>Interfaces</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/protocols>Protocols</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/accessors>Accessors</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/table>Tables</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/telemetry-screens>Screens</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/configuration/ssl-tls>SSL-TLS</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/configuration><span itemprop=name>Configuration</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Telemetry</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>Telemetry</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=telemetry-definition-files>Telemetry Definition Files<a href=#telemetry-definition-files class=hash-link aria-label="Direct link to Telemetry Definition Files" title="Direct link to Telemetry Definition Files"></a></h2>
|
|
2
|
+
<p>Telemetry definition files define the telemetry packets that can be received and processed from COSMOS targets. One large file can be used to define the telemetry packets, or multiple files can be used at the user's discretion. Telemetry definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some telemetry files that depend on others, e.g. they override or extend existing telemetry, they must be named last. The easiest way to do this is to add an extension to an existing file name. For example, if you already have tlm.txt you can create tlm_override.txt for telemetry that depends on the definitions in tlm.txt. Note that due to the way the <a href=http://www.asciitable.com/ target=_blank rel="noopener noreferrer">ASCII Table</a> is structured, files beginning with capital letters are processed before lower case letters.</p>
|
|
13
3
|
<p>When defining telemetry items you can choose from the following data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data. Within COSMOS, the only difference between a STRING and BLOCK is when COSMOS reads a STRING type it stops reading when it encounters a null byte (0). This shows up when displaying the value in Packet Viewer or Tlm Viewer and in the output of Data Extractor. You should strive to store non-ASCII data inside BLOCK items and ASCII strings in STRING items.</p>
|
|
14
|
-
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=
|
|
15
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
16
|
-
<p>All packets require identification items so the incoming data can be matched to a packet structure. These items are defined using the <a href
|
|
17
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
18
|
-
<p>COSMOS specifies a variable sized item with a bit size of 0. When a packet is identified, all other data that isn
|
|
19
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
20
|
-
<p>COSMOS has a concept of a derived item which is a telemetry item that doesn
|
|
21
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
22
|
-
<p>Note the bit offset and bit size of 0 and the data type of DERIVED. For this reason DERIVED items should be declared using ITEM rather than APPEND_ITEM. They can be defined anywhere in the packet definition but are typically placed at the end. The ITEM definition must be followed by a CONVERSION keyword, e.g. <a href
|
|
23
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
4
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Printing Data</div><div class=admonitionContent_bl22><p>Most data types can be printed in a COSMOS script simply by doing <code>print(tlm("TGT PKT ITEM"))</code>. However, if the ITEM is a BLOCK data type and contains binary (non-ASCII) data then that won't work. COSMOS comes with a built-in method called <code>formatted</code> to help you view binary data. If ITEM is a BLOCK type containing binary try <code>puts tlm("TGT PKT ITEM").formatted</code> (Ruby) and <code>print(formatted(tlm("TGT PKT ITEM")))</code> (Python) which will print the bytes out as hex.</div></div>
|
|
5
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=id-items>ID Items<a href=#id-items class=hash-link aria-label="Direct link to ID Items" title="Direct link to ID Items"></a></h3>
|
|
6
|
+
<p>All packets require identification items so the incoming data can be matched to a packet structure. These items are defined using the <a href=/tools/staticdocs/docs/configuration/telemetry#id_item>ID_ITEM</a> and <a href=/tools/staticdocs/docs/configuration/telemetry#append_id_item>APPEND_ID_ITEM</a>. As data is read from the interface and refined by the protocol, the resulting packet is identified by matching all the ID fields. Note that ideally all packets in a particular target should use the exact same bit offset, bit size, and data type to identify. If this is not the case, you must set <a href=/tools/staticdocs/docs/configuration/target#tlm_unique_id_mode>TLM_UNIQUE_ID_MODE</a> in the target.txt file which incurs a performance penalty on every packet identification.</p>
|
|
7
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=variable-sized-items>Variable Sized Items<a href=#variable-sized-items class=hash-link aria-label="Direct link to Variable Sized Items" title="Direct link to Variable Sized Items"></a></h3>
|
|
8
|
+
<p>COSMOS specifies a variable sized item with a bit size of 0. When a packet is identified, all other data that isn't explicitly defined will be put into the variable sized item. These items are typically used for packets containing memory dumps which vary in size depending on the number of bytes dumped. Note that there can only be one variable sized item per packet.</p>
|
|
9
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=derived-items>Derived Items<a href=#derived-items class=hash-link aria-label="Direct link to Derived Items" title="Direct link to Derived Items"></a></h3>
|
|
10
|
+
<p>COSMOS has a concept of a derived item which is a telemetry item that doesn't actually exist in the binary data. Derived items are typically computed based on other telemetry items. COSMOS derived items are very similar to real items except they use the special DERIVED data type. Here is how a derived item might look in a telemetry definition.</p>
|
|
11
|
+
<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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP_AVERAGE</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Average of TEMP1, TEMP2, TEMP3, TEMP4"</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>
|
|
12
|
+
<p>Note the bit offset and bit size of 0 and the data type of DERIVED. For this reason DERIVED items should be declared using ITEM rather than APPEND_ITEM. They can be defined anywhere in the packet definition but are typically placed at the end. The ITEM definition must be followed by a CONVERSION keyword, e.g. <a href=/tools/staticdocs/docs/configuration/telemetry#read_conversion>READ_CONVERSION</a>, to generate the value.</p>
|
|
13
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=received-time-and-packet-time>Received Time and Packet Time<a href=#received-time-and-packet-time class=hash-link aria-label="Direct link to Received Time and Packet Time" title="Direct link to Received Time and Packet Time"></a></h3>
|
|
24
14
|
<p>COSMOS automatically creates several telemetry items on every packet: PACKET_TIMESECONDS, PACKET_TIMEFORMATTED, RECEIVED_COUNT, RECEIVED_TIMEFORMATTED, and RECEIVED_TIMESECONDS.</p>
|
|
25
15
|
<p>RECEIVED_TIME is the time that COSMOS receives the packet. This is set by the interface which is connected to the target and is receiving the raw data. Once a packet has been created out of the raw data the time is set.</p>
|
|
26
|
-
<p>PACKET_TIME defaults to RECEIVED_TIME, but can be set as a derived item with a time object in the telemetry configuration file. This helps support stored telemetry packets so that they can be more reasonably handled by other COSMOS tools such as Telemetry Grapher and Data Extractor. You can set the
|
|
16
|
+
<p>PACKET_TIME defaults to RECEIVED_TIME, but can be set as a derived item with a time object in the telemetry configuration file. This helps support stored telemetry packets so that they can be more reasonably handled by other COSMOS tools such as Telemetry Grapher and Data Extractor. You can set the 'stored' flag in your interface and the current value table is unaffected.</p>
|
|
27
17
|
<p>The _TIMEFORMATTED items returns the date and time in a YYYY/MM/DD HH:MM<!-- -->:SS<!-- -->.sss format and the _TIMESECONDS returns the Unix seconds of the time. Internally these are both stored as either a Ruby Time object or Python date object.</p>
|
|
28
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
18
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=example>Example<a href=#example class=hash-link aria-label="Direct link to Example" title="Direct link to Example"></a></h4>
|
|
29
19
|
<p>COSMOS provides a Unix time conversion class which returns a Ruby Time object or Python date object based on the number of seconds and (optionally) microseconds since the Unix epoch. Note: This returns a native object and not a float or string!</p>
|
|
30
20
|
<p>Ruby Example:</p>
|
|
31
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
21
|
+
<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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PACKET_TIME</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Ruby time based on TIMESEC and TIMEUS"</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)">READ_CONVERSION</span><span class="token plain"> unix_time_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESEC</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMEUS</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>
|
|
32
22
|
<p>Python Example:</p>
|
|
33
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
23
|
+
<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">ITEM PACKET_TIME </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"> DERIVED </span><span class="token string" style="color:rgb(173, 219, 103)">"Python time based on TIMESEC and TIMEUS"</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> READ_CONVERSION openc3</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">conversions</span><span class="token operator" style="color:rgb(127, 219, 202)">/</span><span class="token plain">unix_time_conversion</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py TIMESEC TIMEUS</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>
|
|
34
24
|
<p>Defining PACKET_TIME allows the PACKET_TIMESECONDS and PACKET_TIMEFORMATTED to be calculated against an internal Packet time rather than the time COSMOS receives the packet.</p>
|
|
35
|
-
<div style=
|
|
25
|
+
<div style=clear:both></div>
|
|
36
26
|
<h1>Telemetry Keywords</h1>
|
|
37
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
27
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=telemetry>TELEMETRY<a href=#telemetry class=hash-link aria-label="Direct link to TELEMETRY" title="Direct link to TELEMETRY"></a></h2>
|
|
38
28
|
<p><strong>Defines a new telemetry packet</strong></p>
|
|
39
|
-
<table><thead><tr><th>Parameter
|
|
29
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target<td>Name of the target this telemetry packet is associated with<td>True<tr><td>Command<td>Name of this telemetry packet. Also referred to as its mnemonic. Must be unique to telemetry packets in this target. Ideally will be as short and clear as possible.<td>True<tr><td>Endianness<td>Indicates if the data in this packet is in Big Endian or Little Endian format<br><br>Valid Values: <span class=values>BIG_ENDIAN, LITTLE_ENDIAN</span><td>True<tr><td>Description<td>Description of this telemetry packet which must be enclosed with quotes<td>False</table>
|
|
40
30
|
<p>Example Usage:</p>
|
|
41
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
42
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
31
|
+
<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)">TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Instrument health and status"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
32
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=telemetry-modifiers>TELEMETRY Modifiers<a href=#telemetry-modifiers class=hash-link aria-label="Direct link to TELEMETRY Modifiers" title="Direct link to TELEMETRY Modifiers"></a></h2>
|
|
43
33
|
<p>The following keywords must follow a TELEMETRY keyword.</p>
|
|
44
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
34
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=item>ITEM<a href=#item class=hash-link aria-label="Direct link to ITEM" title="Direct link to ITEM"></a></h3>
|
|
45
35
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
46
|
-
<table><thead><tr><th>Parameter
|
|
36
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Bit Offset<td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item.<td>True<tr><td>Bit Size<td>Bit size of this telemetry item. 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 telemetry item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Description<td>Description for this telemetry item which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the item is to be interpreted 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>
|
|
47
37
|
<p>Example Usage:</p>
|
|
48
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
49
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
38
|
+
<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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PKTID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">112</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 string-literal string" style="color:rgb(173, 219, 103)">"Packet ID"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DATA</span><span class="token plain"> </span><span class="token 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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Derived data"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
39
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=item-modifiers>ITEM Modifiers<a href=#item-modifiers class=hash-link aria-label="Direct link to ITEM Modifiers" title="Direct link to ITEM Modifiers"></a></h3>
|
|
50
40
|
<p>The following keywords must follow a ITEM keyword.</p>
|
|
51
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
41
|
+
<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>
|
|
52
42
|
<p><strong>Adds printf style formatting</strong></p>
|
|
53
|
-
<table><thead><tr><th>Parameter
|
|
43
|
+
<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>
|
|
54
44
|
<p>Example Usage:</p>
|
|
55
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
56
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
45
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">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>
|
|
46
|
+
<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>
|
|
57
47
|
<p><strong>Add displayed units</strong></p>
|
|
58
|
-
<table><thead><tr><th>Parameter
|
|
48
|
+
<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>
|
|
59
49
|
<p>Example Usage:</p>
|
|
60
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
61
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
50
|
+
<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>
|
|
51
|
+
<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>
|
|
62
52
|
<p><strong>Override the defined description</strong></p>
|
|
63
|
-
<table><thead><tr><th>Parameter
|
|
64
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
53
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Value<td>The new description<td>True</table>
|
|
54
|
+
<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>
|
|
65
55
|
<p><strong>Stores custom user metadata</strong></p>
|
|
66
56
|
<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>
|
|
67
|
-
<table><thead><tr><th>Parameter
|
|
68
|
-
<p>Example Usage:</p>
|
|
69
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
70
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
71
|
-
<p
|
|
72
|
-
<p>If an item
|
|
73
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
74
|
-
<p
|
|
75
|
-
<p>Keys are often
|
|
76
|
-
<table><thead><tr><th>Parameter
|
|
77
|
-
<p>Example Usage:</p>
|
|
78
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
79
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
80
|
-
<p
|
|
81
|
-
<table><thead><tr><th>Parameter
|
|
82
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
57
|
+
<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>
|
|
58
|
+
<p>Example Usage:</p>
|
|
59
|
+
<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>
|
|
60
|
+
<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>
|
|
61
|
+
<p><div class=right>(Since 4.4.1)</div><strong>This item is allowed to overlap other items in the packet</strong><p></p>
|
|
62
|
+
<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>
|
|
63
|
+
<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>
|
|
64
|
+
<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>
|
|
65
|
+
<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>
|
|
66
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Key string<td>The key to access this item<td>True</table>
|
|
67
|
+
<p>Example Usage:</p>
|
|
68
|
+
<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>
|
|
69
|
+
<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>
|
|
70
|
+
<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>
|
|
71
|
+
<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>
|
|
72
|
+
<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>
|
|
83
73
|
<p><strong>Defines a key/value pair for the current item</strong></p>
|
|
84
74
|
<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 telemetry item and allows for much greater clarity and less chance for user error. A catch all value of ANY applies to all other values not already defined as state values.</p>
|
|
85
|
-
<table><thead><tr><th>Parameter
|
|
75
|
+
<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 or ANY to apply the state to all other values<td>True<tr><td>Color<td>The color the state should be displayed as<br><br>Valid Values: <span class=values>GREEN, YELLOW, RED</span><td>False</table>
|
|
86
76
|
<p>Example Usage:</p>
|
|
87
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
88
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
77
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ITEM</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 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)">STATE</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ERROR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANY</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Match all other values to ERROR</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_ITEM</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)">"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)">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)">GREEN</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)">YELLOW</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)">RED</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
78
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=read_conversion>READ_CONVERSION<a href=#read_conversion class=hash-link aria-label="Direct link to READ_CONVERSION" title="Direct link to READ_CONVERSION"></a></h4>
|
|
89
79
|
<p><strong>Applies a conversion to the current telemetry item</strong></p>
|
|
90
|
-
<p>Conversions are implemented in a custom Ruby or Python file which should be located in the target
|
|
91
|
-
<table><thead><tr><th>Parameter
|
|
80
|
+
<p>Conversions are implemented in a custom Ruby or Python file which should be located in the target's lib folder. The class must inherit from Conversion. It must implement the <code>initialize</code> (Ruby) or <code>__init__</code> (Python) method if it takes extra parameters and must always implement the <code>call</code> method. The conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
81
|
+
<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>
|
|
92
82
|
<p>Ruby Example:</p>
|
|
93
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
83
|
+
<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)">READ_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"> </span><span class="token variable" style="color:rgb(214, 222, 235)">@multiplier</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><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>
|
|
94
84
|
<p>Python Example:</p>
|
|
95
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
96
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
85
|
+
<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">READ_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>
|
|
86
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=poly_read_conversion>POLY_READ_CONVERSION<a href=#poly_read_conversion class=hash-link aria-label="Direct link to POLY_READ_CONVERSION" title="Direct link to POLY_READ_CONVERSION"></a></h4>
|
|
97
87
|
<p><strong>Adds a polynomial conversion factor to the current telemetry item</strong></p>
|
|
98
88
|
<p>The conversion factor is applied to raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
99
|
-
<table><thead><tr><th>Parameter
|
|
89
|
+
<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>
|
|
100
90
|
<p>Example Usage:</p>
|
|
101
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
102
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
91
|
+
<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_READ_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>
|
|
92
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=seg_poly_read_conversion>SEG_POLY_READ_CONVERSION<a href=#seg_poly_read_conversion class=hash-link aria-label="Direct link to SEG_POLY_READ_CONVERSION" title="Direct link to SEG_POLY_READ_CONVERSION"></a></h4>
|
|
103
93
|
<p><strong>Adds a segmented polynomial conversion factor to the current telemetry item</strong></p>
|
|
104
94
|
<p>This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog.</p>
|
|
105
|
-
<table><thead><tr><th>Parameter
|
|
95
|
+
<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>
|
|
106
96
|
<p>Example Usage:</p>
|
|
107
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
108
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
97
|
+
<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_READ_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_READ_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_READ_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>
|
|
98
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=generic_read_conversion_start>GENERIC_READ_CONVERSION_START<a href=#generic_read_conversion_start class=hash-link aria-label="Direct link to GENERIC_READ_CONVERSION_START" title="Direct link to GENERIC_READ_CONVERSION_START"></a></h4>
|
|
109
99
|
<p><strong>Start a generic read conversion</strong></p>
|
|
110
|
-
<p>Adds a generic conversion function to the current telemetry item. This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog. The conversion is specified as Ruby or Python code that receives two implied parameters.
|
|
111
|
-
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=
|
|
112
|
-
<table><thead><tr><th>Parameter
|
|
100
|
+
<p>Adds a generic conversion function to the current telemetry item. This conversion factor is applied to the raw value in the telemetry packet before it is displayed to the user. The user still has the ability to see the raw unconverted value in a details dialog. The conversion is specified as Ruby or Python code that receives two implied parameters. 'value' which is the raw value being read and 'packet' which is a reference to the telemetry packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of code should return the converted value. The GENERIC_READ_CONVERSION_END keyword specifies that all lines of code for the conversion have been given.</p>
|
|
101
|
+
<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 READ_CONVERSION instead. READ_CONVERSION is easier to debug and has higher performance.</div></div>
|
|
102
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Converted Type<td>Type of the converted value<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK</span><td>False<tr><td>Converted Bit Size<td>Bit size of converted value<td>False</table>
|
|
113
103
|
<p>Ruby Example:</p>
|
|
114
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
104
|
+
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token constant" style="color:rgb(130, 170, 255)">APPEND_ITEM</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><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_READ_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_READ_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>
|
|
115
105
|
<p>Python Example:</p>
|
|
116
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
117
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
106
|
+
<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_ITEM ITEM1 </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"> UINT</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> GENERIC_READ_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_READ_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>
|
|
107
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=generic_read_conversion_end>GENERIC_READ_CONVERSION_END<a href=#generic_read_conversion_end class=hash-link aria-label="Direct link to GENERIC_READ_CONVERSION_END" title="Direct link to GENERIC_READ_CONVERSION_END"></a></h4>
|
|
118
108
|
<p><strong>Complete a generic read conversion</strong></p>
|
|
119
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
109
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=limits>LIMITS<a href=#limits class=hash-link aria-label="Direct link to LIMITS" title="Direct link to LIMITS"></a></h4>
|
|
120
110
|
<p><strong>Defines a set of limits for a telemetry item</strong></p>
|
|
121
|
-
<p>If limits are violated a message is printed in the Command and Telemetry Server to indicate an item went out of limits. Other tools also use this information to update displays with different colored telemetry items or other useful information. The concept of
|
|
122
|
-
<table><thead><tr><th>Parameter
|
|
111
|
+
<p>If limits are violated a message is printed in the Command and Telemetry Server to indicate an item went out of limits. Other tools also use this information to update displays with different colored telemetry items or other useful information. The concept of "limits sets" is defined to allow for different limits values in different environments. For example, you might want tighter or looser limits on telemetry if your environment changes such as during thermal vacuum testing.</p>
|
|
112
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Limits Set<td>Name of the limits set. If you have no unique limits sets use the keyword DEFAULT.<td>True<tr><td>Persistence<td>Number of consecutive times the telemetry item must be within a different limits range before changing limits state.<td>True<tr><td>Initial State<td>Whether limits monitoring for this telemetry item is initially enabled or disabled. Note if you have multiple LIMITS items they should all have the same initial state.<br><br>Valid Values: <span class=values>ENABLED, DISABLED</span><td>True<tr><td>Red Low Limit<td>If the telemetry value is less than or equal to this value a Red Low condition will be detected<td>True<tr><td>Yellow Low Limit<td>If the telemetry value is less than or equal to this value, but greater than the Red Low Limit, a Yellow Low condition will be detected<td>True<tr><td>Yellow High Limit<td>If the telemetry value is greater than or equal to this value, but less than the Red High Limit, a Yellow High condition will be detected<td>True<tr><td>Red High Limit<td>If the telemetry value is greater than or equal to this value a Red High condition will be detected<td>True<tr><td>Green Low Limit<td>Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is greater than or equal to this value, but less than the Green High Limit, a Blue operational condition will be detected.<td>False<tr><td>Green High Limit<td>Setting the Green Low and Green High limits defines an "operational limit" which is colored blue by OpenC3. This allows for a distinct desired operational range which is narrower than the green safety limit. If the telemetry value is less than or equal to this value, but greater than the Green Low Limit, a Blue operational condition will be detected.<td>False</table>
|
|
123
113
|
<p>Example Usage:</p>
|
|
124
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
125
|
-
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
114
|
+
<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)">LIMITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT</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 constant" style="color:rgb(130, 170, 255)">ENABLED</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">70.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">60.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">20.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20.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)">LIMITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TVAC</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 constant" style="color:rgb(130, 170, 255)">ENABLED</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">30.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">30.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
115
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=limits_response>LIMITS_RESPONSE<a href=#limits_response class=hash-link aria-label="Direct link to LIMITS_RESPONSE" title="Direct link to LIMITS_RESPONSE"></a></h4>
|
|
126
116
|
<p><strong>Defines a response class that is called when the limits state of the current item changes</strong></p>
|
|
127
|
-
<table><thead><tr><th>Parameter
|
|
117
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Response Class Filename<td>Name of the Ruby or Python file which implements the limits response. This file should be in the target's lib directory.<td>True<tr><td>Response Specific Options<td>Variable length number of options that will be passed to the class constructor<td>False</table>
|
|
128
118
|
<p>Ruby Example:</p>
|
|
129
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
119
|
+
<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)">LIMITS_RESPONSE</span><span class="token plain"> example_limits_response</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)">10</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
120
|
<p>Python Example:</p>
|
|
131
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
132
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
121
|
+
<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">LIMITS_RESPONSE example_limits_response</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)">10</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>
|
|
122
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_item>APPEND_ITEM<a href=#append_item class=hash-link aria-label="Direct link to APPEND_ITEM" title="Direct link to APPEND_ITEM"></a></h3>
|
|
133
123
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
134
|
-
<table><thead><tr><th>Parameter
|
|
124
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Bit Size<td>Bit size of this telemetry item. 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 telemetry item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Description<td>Description for this telemetry item which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the item is to be interpreted 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>
|
|
135
125
|
<p>Example Usage:</p>
|
|
136
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
137
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
138
|
-
<p><strong>Defines a telemetry item in the current telemetry packet. Note, packets defined without one or more ID_ITEMs are
|
|
139
|
-
<table><thead><tr><th>Parameter
|
|
126
|
+
<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_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PKTID</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 string-literal string" style="color:rgb(173, 219, 103)">"Packet ID"</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>
|
|
127
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=id_item>ID_ITEM<a href=#id_item class=hash-link aria-label="Direct link to ID_ITEM" title="Direct link to ID_ITEM"></a></h3>
|
|
128
|
+
<p><strong>Defines a telemetry item in the current telemetry packet. Note, packets defined without one or more ID_ITEMs are "catch-all" packets which will match all incoming data. Normally this is the job of the UNKNOWN packet.</strong></p>
|
|
129
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Bit Offset<td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet.<td>True<tr><td>Bit Size<td>Bit size of this telemetry item. 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.<td>True<tr><td>Data Type<td>Data Type of this telemetry item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK</span><td>True<tr><td>ID Value<td>The value of this telemetry item that uniquely identifies this telemetry packet<td>True<tr><td>Description<td>Description for this telemetry item which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the item is to be interpreted 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>
|
|
140
130
|
<p>Example Usage:</p>
|
|
141
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
142
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
131
|
+
<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)">ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PKTID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">112</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)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Packet ID which must be 1"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
132
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_id_item>APPEND_ID_ITEM<a href=#append_id_item class=hash-link aria-label="Direct link to APPEND_ID_ITEM" title="Direct link to APPEND_ID_ITEM"></a></h3>
|
|
143
133
|
<p><strong>Defines a telemetry item in the current telemetry packet</strong></p>
|
|
144
|
-
<table><thead><tr><th>Parameter
|
|
134
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Bit Size<td>Bit size of this telemetry item. 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.<td>True<tr><td>Data Type<td>Data Type of this telemetry item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK</span><td>True<tr><td>ID Value<td>The value of this telemetry item that uniquely identifies this telemetry packet<td>True<tr><td>Description<td>Description for this telemetry item which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the item is to be interpreted 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>
|
|
145
135
|
<p>Example Usage:</p>
|
|
146
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
147
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
136
|
+
<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_ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">PKTID</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)">1</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Packet ID which must be 1"</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
137
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=array_item>ARRAY_ITEM<a href=#array_item class=hash-link aria-label="Direct link to ARRAY_ITEM" title="Direct link to ARRAY_ITEM"></a></h3>
|
|
148
138
|
<p><strong>Defines a telemetry item in the current telemetry packet that is an array</strong></p>
|
|
149
|
-
<table><thead><tr><th>Parameter
|
|
139
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Bit Offset<td>Bit offset into the telemetry packet of the Most Significant Bit of this item. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived item.<td>True<tr><td>Item Bit Size<td>Bit size of each array item<td>True<tr><td>Item Data Type<td>Data Type of each array item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Array Bit Size<td>Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value.<td>True<tr><td>Description<td>Description which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data 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>
|
|
150
140
|
<p>Example Usage:</p>
|
|
151
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
152
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
141
|
+
<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)">ARRAY_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</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)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">320</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Array of 10 floats"</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>
|
|
142
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=append_array_item>APPEND_ARRAY_ITEM<a href=#append_array_item class=hash-link aria-label="Direct link to APPEND_ARRAY_ITEM" title="Direct link to APPEND_ARRAY_ITEM"></a></h3>
|
|
153
143
|
<p><strong>Defines a telemetry item in the current telemetry packet that is an array</strong></p>
|
|
154
|
-
<table><thead><tr><th>Parameter
|
|
144
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Name<td>Name of the telemety item. Must be unique within the packet.<td>True<tr><td>Item Bit Size<td>Bit size of each array item<td>True<tr><td>Item Data Type<td>Data Type of each array item<br><br>Valid Values: <span class=values>INT, UINT, FLOAT, STRING, BLOCK, DERIVED</span><td>True<tr><td>Array Bit Size<td>Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value.<td>True<tr><td>Description<td>Description which must be enclosed with quotes<td>False<tr><td>Endianness<td>Indicates if the data 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>
|
|
155
145
|
<p>Example Usage:</p>
|
|
156
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
157
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
146
|
+
<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_ARRAY_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ARRAY</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)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">320</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Array of 10 floats"</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>
|
|
147
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=select_item>SELECT_ITEM<a href=#select_item class=hash-link aria-label="Direct link to SELECT_ITEM" title="Direct link to SELECT_ITEM"></a></h3>
|
|
158
148
|
<p><strong>Selects an existing telemetry item for editing</strong></p>
|
|
159
149
|
<p>Must be used in conjunction with SELECT_TELEMETRY to first select the packet. Typically used to override generated values or make specific changes to telemetry that only affect a particular instance of a target used multiple times.</p>
|
|
160
|
-
<table><thead><tr><th>Parameter
|
|
150
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Item<td>Name of the item to select for modification<td>True</table>
|
|
161
151
|
<p>Example Usage:</p>
|
|
162
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
163
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
164
|
-
<p
|
|
165
|
-
<p>Deleting an item from the packet definition does not remove the defined space for that item. Thus unless you redefine a new item, there will be a
|
|
166
|
-
<table><thead><tr><th>Parameter
|
|
152
|
+
<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)">SELECT_TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</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)">SELECT_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Define limits for this item, overrides or replaces any existing</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)">LIMITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT</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 constant" style="color:rgb(130, 170, 255)">ENABLED</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">90.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">90.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">20.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20.0</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
153
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=delete_item>DELETE_ITEM<a href=#delete_item class=hash-link aria-label="Direct link to DELETE_ITEM" title="Direct link to DELETE_ITEM"></a></h3>
|
|
154
|
+
<p><div class=right>(Since 4.4.1)</div><strong>Delete an existing telemetry item from the packet definition</strong><p></p>
|
|
155
|
+
<p>Deleting an item from the packet definition does not remove the defined space for that item. Thus unless you redefine a new item, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_TELEMETRY and then ITEM to define a new item.</p>
|
|
156
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Item<td>Name of the item to delete<td>True</table>
|
|
167
157
|
<p>Example Usage:</p>
|
|
168
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
169
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
158
|
+
<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)">SELECT_TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</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)">DELETE_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP4</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>
|
|
159
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=meta-1>META<a href=#meta-1 class=hash-link aria-label="Direct link to META" title="Direct link to META"></a></h3>
|
|
170
160
|
<p><strong>Stores metadata for the current telemetry packet</strong></p>
|
|
171
161
|
<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>
|
|
172
|
-
<table><thead><tr><th>Parameter
|
|
162
|
+
<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>
|
|
173
163
|
<p>Example Usage:</p>
|
|
174
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
175
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
164
|
+
<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)">FSW_TYPE</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"struct tlm_packet"</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>
|
|
165
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=processor>PROCESSOR<a href=#processor class=hash-link aria-label="Direct link to PROCESSOR" title="Direct link to PROCESSOR"></a></h3>
|
|
176
166
|
<p><strong>Defines a processor class that executes code every time a packet is received</strong></p>
|
|
177
|
-
<table><thead><tr><th>Parameter
|
|
167
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Processor Name<td>The name of the processor<td>True<tr><td>Processor Class Filename<td>Name of the Ruby or Python file which implements the processor. This file should be in the target's lib directory.<td>True<tr><td>Processor Specific Options<td>Variable length number of options that will be passed to the class constructor.<td>False</table>
|
|
178
168
|
<p>Ruby Example:</p>
|
|
179
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
169
|
+
<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)">PROCESSOR</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1HIGH</span><span class="token plain"> watermark_processor</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">rb </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1</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>
|
|
180
170
|
<p>Python Example:</p>
|
|
181
|
-
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style
|
|
182
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
171
|
+
<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">PROCESSOR TEMP1HIGH watermark_processor</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">py TEMP1</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>
|
|
172
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=allow_short>ALLOW_SHORT<a href=#allow_short class=hash-link aria-label="Direct link to ALLOW_SHORT" title="Direct link to ALLOW_SHORT"></a></h3>
|
|
183
173
|
<p><strong>Process telemetry packets which are less than their defined length</strong></p>
|
|
184
174
|
<p>Allows the telemetry packet to be received with a data portion that is smaller than the defined size without warnings. Any extra space in the packet will be filled in with zeros by OpenC3.</p>
|
|
185
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
175
|
+
<h3 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></h3>
|
|
186
176
|
<p><strong>Hides this telemetry packet from all the OpenC3 tools</strong></p>
|
|
187
177
|
<p>This packet will not appear in Packet Viewer, Telemetry Grapher and Handbook Creator. It also hides this telemetry from appearing in the Script Runner popup helper when writing scripts. The telemetry still exists in the system and can received and checked by scripts.</p>
|
|
188
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
189
|
-
<p
|
|
190
|
-
<p>Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor.
|
|
191
|
-
<table><thead><tr><th>Parameter
|
|
192
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
193
|
-
<p
|
|
178
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=accessor>ACCESSOR<a href=#accessor class=hash-link aria-label="Direct link to ACCESSOR" title="Direct link to ACCESSOR"></a></h3>
|
|
179
|
+
<p><div class=right>(Since 5.0.10)</div><strong>Defines the class used to read and write raw values from the packet</strong><p></p>
|
|
180
|
+
<p>Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. For more information see <a href=/tools/staticdocs/docs/configuration/accessors>Accessors</a>.</p>
|
|
181
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Accessor Class Name<td>The name of the accessor class<td>True</table>
|
|
182
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=template>TEMPLATE<a href=#template class=hash-link aria-label="Direct link to TEMPLATE" title="Direct link to TEMPLATE"></a></h3>
|
|
183
|
+
<p><div class=right>(Since 5.0.10)</div><strong>Defines a template string used to pull telemetry values from a string buffer</strong><p></p>
|
|
184
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Template<td>The template string which should be enclosed in quotes<td>True</table>
|
|
185
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=template_file>TEMPLATE_FILE<a href=#template_file class=hash-link aria-label="Direct link to TEMPLATE_FILE" title="Direct link to TEMPLATE_FILE"></a></h3>
|
|
186
|
+
<p><div class=right>(Since 5.0.10)</div><strong>Defines a template file used to pull telemetry values from a string buffer</strong><p></p>
|
|
187
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Template File Path<td>The relative path to the template file. Filename should generally start with an underscore.<td>True</table>
|
|
188
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ignore_overlap>IGNORE_OVERLAP<a href=#ignore_overlap class=hash-link aria-label="Direct link to IGNORE_OVERLAP" title="Direct link to IGNORE_OVERLAP"></a></h3>
|
|
189
|
+
<p><div class=right>(Since 5.16.0)</div><strong>Ignores any packet items which overlap</strong><p></p>
|
|
194
190
|
<p>Packet items which overlap normally generate a warning unless each individual item has the OVERLAP keyword. This ignores overlaps across the entire packet.</p>
|
|
195
|
-
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
196
|
-
<p
|
|
191
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=virtual>VIRTUAL<a href=#virtual class=hash-link aria-label="Direct link to VIRTUAL" title="Direct link to VIRTUAL"></a></h3>
|
|
192
|
+
<p><div class=right>(Since 5.18.0)</div><strong>Marks this packet as virtual and not participating in identification</strong><p></p>
|
|
197
193
|
<p>Used for packet definitions that can be used as structures for items with a given packet.</p>
|
|
198
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
194
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=select_telemetry>SELECT_TELEMETRY<a href=#select_telemetry class=hash-link aria-label="Direct link to SELECT_TELEMETRY" title="Direct link to SELECT_TELEMETRY"></a></h2>
|
|
199
195
|
<p><strong>Selects an existing telemetry packet for editing</strong></p>
|
|
200
196
|
<p>Typically used in a separate configuration file from where the original telemetry is defined to override or add to the existing telemetry definition. Must be used in conjunction with SELECT_ITEM to change an individual item.</p>
|
|
201
|
-
<table><thead><tr><th>Parameter
|
|
197
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Name of the target this telemetry packet is associated with<td>True<tr><td>Packet Name<td>Name of the telemetry packet to select<td>True</table>
|
|
202
198
|
<p>Example Usage:</p>
|
|
203
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
204
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
199
|
+
<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)">SELECT_TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</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)">SELECT_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Define limits for this item, overrides or replaces any existing</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)">LIMITS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">DEFAULT</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 constant" style="color:rgb(130, 170, 255)">ENABLED</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">90.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">80.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">90.0</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">-</span><span class="token number" style="color:rgb(247, 140, 108)">20.0</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20.0</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
|
200
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=limits_group>LIMITS_GROUP<a href=#limits_group class=hash-link aria-label="Direct link to LIMITS_GROUP" title="Direct link to LIMITS_GROUP"></a></h2>
|
|
205
201
|
<p><strong>Defines a group of related limits Items</strong></p>
|
|
206
|
-
<p>Limits groups contain telemetry items that can be enabled and disabled together. It can be used to group related limits as a subsystem that can be enabled or disabled as that particular subsystem is powered (for example). To enable a group call the enable_limits_group(
|
|
207
|
-
<table><thead><tr><th>Parameter
|
|
208
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
202
|
+
<p>Limits groups contain telemetry items that can be enabled and disabled together. It can be used to group related limits as a subsystem that can be enabled or disabled as that particular subsystem is powered (for example). To enable a group call the enable_limits_group("NAME") method in Script Runner. To disable a group call the disable_limits_group("NAME") in Script Runner. Items can belong to multiple groups but the last enabled or disabled group "wins". For example, if an item belongs to GROUP1 and GROUP2 and you first enable GROUP1 and then disable GROUP2 the item will be disabled. If you then enable GROUP1 again it will be enabled.</p>
|
|
203
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Group Name<td>Name of the limits group<td>True</table>
|
|
204
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=limits_group_item>LIMITS_GROUP_ITEM<a href=#limits_group_item class=hash-link aria-label="Direct link to LIMITS_GROUP_ITEM" title="Direct link to LIMITS_GROUP_ITEM"></a></h2>
|
|
209
205
|
<p><strong>Adds the specified telemetry item to the last defined LIMITS_GROUP</strong></p>
|
|
210
206
|
<p>Limits group information is typically kept in a separate configuration file in the config/TARGET/cmd_tlm folder named limits_groups.txt.</p>
|
|
211
|
-
<table><thead><tr><th>Parameter
|
|
207
|
+
<table><thead><tr><th>Parameter<th>Description<th>Required<tbody><tr><td>Target Name<td>Name of the target<td>True<tr><td>Packet Name<td>Name of the packet<td>True<tr><td>Item Name<td>Name of the telemetry item to add to the group<td>True</table>
|
|
212
208
|
<p>Example Usage:</p>
|
|
213
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style
|
|
214
|
-
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=
|
|
209
|
+
<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)">LIMITS_GROUP</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">SUBSYSTEM</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)">LIMITS_GROUP_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP1</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)">LIMITS_GROUP_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP2</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)">LIMITS_GROUP_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">INST</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HEALTH_STATUS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TEMP3</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>
|
|
210
|
+
<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>
|
|
215
211
|
<p><strong>Example File: TARGET/cmd_tlm/tlm.txt</strong></p>
|
|
216
|
-
<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)">TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Health and Status for My Target"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</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)">3</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET VERSION NUMBER (SEE CCSDS 133.0-B-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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</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)">1</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET TYPE (COMMAND OR TELEMETRY)"</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)">TLM</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)">CMD</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS SECONDARY HEADER FLAG"</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)">ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS APPLICATION PROCESS ID"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS SEQUENCE FLAGS"</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)">FIRST</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)">CONT</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)">LAST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</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)">NOGROUP</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET SEQUENCE COUNT"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</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 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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET DATA LENGTH"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSDAY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</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 string-literal string" style="color:rgb(173, 219, 103)">"DAYS SINCE EPOCH (JANUARY 1ST, 1958, MIDNIGHT)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSMSOD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</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 string-literal string" style="color:rgb(173, 219, 103)">"MILLISECONDS OF DAY (0 - 86399999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSUSOMS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">96</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 string-literal string" style="color:rgb(173, 219, 103)">"MICROSECONDS OF MILLISECOND (0-999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLEDEG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">112</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)">INT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Instrument Angle in Degrees"</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)">POLY_READ_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)">57.295</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">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 string-literal string" style="color:rgb(173, 219, 103)">"Instrument Mode"</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)">NORMAL</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 constant" style="color:rgb(130, 170, 255)">GREEN</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)">DIAG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">YELLOW</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESECONDS</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH IN SECONDS"</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_READ_CONVERSION_START</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </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">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">86400.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">1000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">1000000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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 constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_END</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMEFORMATTED</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH AS A FORMATTED 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)">GENERIC_READ_CONVERSION_START</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)">216</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> time </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)">Time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">ccsds2mdy</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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</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"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</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"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</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"> sprintf</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'%04u/%02u/%02u %02u:%02u:%02u.%06u'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">0</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">1</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">2</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">3</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">4</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">6</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 constant" style="color:rgb(130, 170, 255)">GENERIC_READ_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"></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/telemetry.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/command"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interfaces</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="#telemetry-definition-files" class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href="#id-items" class="table-of-contents__link toc-highlight">ID Items</a></li><li><a href="#variable-sized-items" class="table-of-contents__link toc-highlight">Variable Sized Items</a></li><li><a href="#derived-items" class="table-of-contents__link toc-highlight">Derived Items</a></li><li><a href="#received-time-and-packet-time" class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li></ul></li></ul></li><li><a href="#telemetry" class="table-of-contents__link toc-highlight">TELEMETRY</a></li><li><a href="#telemetry-modifiers" class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href="#item" class="table-of-contents__link toc-highlight">ITEM</a></li><li><a href="#item-modifiers" class="table-of-contents__link toc-highlight">ITEM 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="#state" class="table-of-contents__link toc-highlight">STATE</a></li><li><a href="#read_conversion" class="table-of-contents__link toc-highlight">READ_CONVERSION</a></li><li><a href="#poly_read_conversion" class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a></li><li><a href="#seg_poly_read_conversion" class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a></li><li><a href="#generic_read_conversion_start" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a></li><li><a href="#generic_read_conversion_end" class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a></li><li><a href="#limits" class="table-of-contents__link toc-highlight">LIMITS</a></li><li><a href="#limits_response" class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></li></ul></li><li><a href="#append_item" class="table-of-contents__link toc-highlight">APPEND_ITEM</a></li><li><a href="#id_item" class="table-of-contents__link toc-highlight">ID_ITEM</a></li><li><a href="#append_id_item" class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a></li><li><a href="#array_item" class="table-of-contents__link toc-highlight">ARRAY_ITEM</a></li><li><a href="#append_array_item" class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a></li><li><a href="#select_item" class="table-of-contents__link toc-highlight">SELECT_ITEM</a></li><li><a href="#delete_item" class="table-of-contents__link toc-highlight">DELETE_ITEM</a></li><li><a href="#meta-1" class="table-of-contents__link toc-highlight">META</a></li><li><a href="#processor" class="table-of-contents__link toc-highlight">PROCESSOR</a></li><li><a href="#allow_short" class="table-of-contents__link toc-highlight">ALLOW_SHORT</a></li><li><a href="#hidden" class="table-of-contents__link toc-highlight">HIDDEN</a></li><li><a href="#accessor" class="table-of-contents__link toc-highlight">ACCESSOR</a></li><li><a href="#ignore_overlap" class="table-of-contents__link toc-highlight">IGNORE_OVERLAP</a></li><li><a href="#virtual" class="table-of-contents__link toc-highlight">VIRTUAL</a></li></ul></li><li><a href="#select_telemetry" class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a></li><li><a href="#limits_group" class="table-of-contents__link toc-highlight">LIMITS_GROUP</a></li><li><a href="#limits_group_item" class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</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>
|
|
217
|
-
</body>
|
|
218
|
-
</html>
|
|
212
|
+
<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)">TELEMETRY</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TARGET</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">HS</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">BIG_ENDIAN</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Health and Status for My Target"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSVER</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)">3</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET VERSION NUMBER (SEE CCSDS 133.0-B-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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSTYPE</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)">1</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET TYPE (COMMAND OR TELEMETRY)"</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)">TLM</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)">CMD</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSHF</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS SECONDARY HEADER FLAG"</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)">ID_ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSAPID</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5</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 constant" style="color:rgb(130, 170, 255)">UINT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">102</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"CCSDS APPLICATION PROCESS ID"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQFLAGS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">16</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS SEQUENCE FLAGS"</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)">FIRST</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)">CONT</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)">LAST</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</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)">NOGROUP</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSSEQCNT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">18</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">14</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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET SEQUENCE COUNT"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSLENGTH</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 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 string-literal string" style="color:rgb(173, 219, 103)">"CCSDS PACKET DATA LENGTH"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSDAY</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">48</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 string-literal string" style="color:rgb(173, 219, 103)">"DAYS SINCE EPOCH (JANUARY 1ST, 1958, MIDNIGHT)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSMSOD</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">64</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 string-literal string" style="color:rgb(173, 219, 103)">"MILLISECONDS OF DAY (0 - 86399999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">CCSDSUSOMS</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">96</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 string-literal string" style="color:rgb(173, 219, 103)">"MICROSECONDS OF MILLISECOND (0-999)"</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">ANGLEDEG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">112</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)">INT</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"Instrument Angle in Degrees"</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)">POLY_READ_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)">57.295</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">128</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">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 string-literal string" style="color:rgb(173, 219, 103)">"Instrument Mode"</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)">NORMAL</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 constant" style="color:rgb(130, 170, 255)">GREEN</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)">DIAG</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">YELLOW</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMESECONDS</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH IN SECONDS"</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_READ_CONVERSION_START</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">FLOAT</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">32</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </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">packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">86400.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">1000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> </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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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)">1000000.0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </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 constant" style="color:rgb(130, 170, 255)">GENERIC_READ_CONVERSION_END</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)">ITEM</span><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">TIMEFORMATTED</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 constant" style="color:rgb(130, 170, 255)">DERIVED</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">"DERIVED TIME SINCE EPOCH AS A FORMATTED 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)">GENERIC_READ_CONVERSION_START</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)">216</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> time </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)">Time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">ccsds2mdy</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">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsday'</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"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsmsod'</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"> packet</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">read</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'ccsdsusoms'</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"> sprintf</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'%04u/%02u/%02u %02u:%02u:%02u.%06u'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">0</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">1</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">2</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">3</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">4</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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">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"> time</span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token number" style="color:rgb(247, 140, 108)">6</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 constant" style="color:rgb(130, 170, 255)">GENERIC_READ_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></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/telemetry.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/command><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Commands</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/configuration/interfaces><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Interfaces</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=#telemetry-definition-files class="table-of-contents__link toc-highlight">Telemetry Definition Files</a><ul><li><a href=#id-items class="table-of-contents__link toc-highlight">ID Items</a><li><a href=#variable-sized-items class="table-of-contents__link toc-highlight">Variable Sized Items</a><li><a href=#derived-items class="table-of-contents__link toc-highlight">Derived Items</a><li><a href=#received-time-and-packet-time class="table-of-contents__link toc-highlight">Received Time and Packet Time</a><ul><li><a href=#example class="table-of-contents__link toc-highlight">Example</a></ul></ul><li><a href=#telemetry class="table-of-contents__link toc-highlight">TELEMETRY</a><li><a href=#telemetry-modifiers class="table-of-contents__link toc-highlight">TELEMETRY Modifiers</a><ul><li><a href=#item class="table-of-contents__link toc-highlight">ITEM</a><li><a href=#item-modifiers class="table-of-contents__link toc-highlight">ITEM 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=#state class="table-of-contents__link toc-highlight">STATE</a><li><a href=#read_conversion class="table-of-contents__link toc-highlight">READ_CONVERSION</a><li><a href=#poly_read_conversion class="table-of-contents__link toc-highlight">POLY_READ_CONVERSION</a><li><a href=#seg_poly_read_conversion class="table-of-contents__link toc-highlight">SEG_POLY_READ_CONVERSION</a><li><a href=#generic_read_conversion_start class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_START</a><li><a href=#generic_read_conversion_end class="table-of-contents__link toc-highlight">GENERIC_READ_CONVERSION_END</a><li><a href=#limits class="table-of-contents__link toc-highlight">LIMITS</a><li><a href=#limits_response class="table-of-contents__link toc-highlight">LIMITS_RESPONSE</a></ul><li><a href=#append_item class="table-of-contents__link toc-highlight">APPEND_ITEM</a><li><a href=#id_item class="table-of-contents__link toc-highlight">ID_ITEM</a><li><a href=#append_id_item class="table-of-contents__link toc-highlight">APPEND_ID_ITEM</a><li><a href=#array_item class="table-of-contents__link toc-highlight">ARRAY_ITEM</a><li><a href=#append_array_item class="table-of-contents__link toc-highlight">APPEND_ARRAY_ITEM</a><li><a href=#select_item class="table-of-contents__link toc-highlight">SELECT_ITEM</a><li><a href=#delete_item class="table-of-contents__link toc-highlight">DELETE_ITEM</a><li><a href=#meta-1 class="table-of-contents__link toc-highlight">META</a><li><a href=#processor class="table-of-contents__link toc-highlight">PROCESSOR</a><li><a href=#allow_short class="table-of-contents__link toc-highlight">ALLOW_SHORT</a><li><a href=#hidden class="table-of-contents__link toc-highlight">HIDDEN</a><li><a href=#accessor class="table-of-contents__link toc-highlight">ACCESSOR</a><li><a href=#template class="table-of-contents__link toc-highlight">TEMPLATE</a><li><a href=#template_file class="table-of-contents__link toc-highlight">TEMPLATE_FILE</a><li><a href=#ignore_overlap class="table-of-contents__link toc-highlight">IGNORE_OVERLAP</a><li><a href=#virtual class="table-of-contents__link toc-highlight">VIRTUAL</a></ul><li><a href=#select_telemetry class="table-of-contents__link toc-highlight">SELECT_TELEMETRY</a><li><a href=#limits_group class="table-of-contents__link toc-highlight">LIMITS_GROUP</a><li><a href=#limits_group_item class="table-of-contents__link toc-highlight">LIMITS_GROUP_ITEM</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>
|