openc3-cosmos-tool-docs 5.13.0 → 5.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/plugin.txt +1 -1
- data/tools/staticdocs/404.html +5 -5
- data/tools/staticdocs/assets/css/styles.dd31dbff.css +1 -0
- data/tools/staticdocs/assets/images/add_component-883814db1de410921a1d46247be60a87a51f1c51eb98d4a7f499875c83225294.png +0 -0
- data/tools/staticdocs/assets/images/add_item-4e7c51e0d6a7304260097ccfe8a64d7f2d2b428dba9758070a618ca0dcc89457.png +0 -0
- data/tools/staticdocs/assets/images/add_packet-74322c89982856286103da2c91c4246a4a8aa319c216bc1c169515ab28381cd6.png +0 -0
- data/tools/staticdocs/assets/images/add_target-f1f0d16faf5f3c1ecdfe3daa90d44d082053845d5f7a59e988d90ff0b5ba00ff.png +0 -0
- data/tools/staticdocs/assets/images/autonomic-a2118149a079f587f8f373d61f65d4d6d5e4b3df41ec5446362a449a3b51a1b3.png +0 -0
- data/tools/staticdocs/assets/images/blank_calendar-70e605942120937b862bd7039348229bab9af1f9c93d356ddbf401a3e8543c74.png +0 -0
- data/tools/staticdocs/assets/images/bucket_explorer-ba88a20121198c3441a6af5302ab1a6ad62a171661037e9e3bfd312ca8bdb5ef.png +0 -0
- data/tools/staticdocs/assets/images/calendar-dacbcbb05175c76f3406b4aaade0465444c20b72e93366c79fed1f6eec018c42.png +0 -0
- data/tools/staticdocs/assets/images/change_limits_set-b72da282ea28d783bd7e1d0cd48db72486dacb4e76e1cd46d52c7999028d9c0d.png +0 -0
- data/tools/staticdocs/assets/images/checks_rb-89f400098ff47774008ea420860c665c15ebf06819c3ee7050bed301ea0a9f46.png +0 -0
- data/tools/staticdocs/assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png +0 -0
- data/tools/staticdocs/assets/images/cmd_raw-28307ac400b66050ada7ecc8b7701deffe8fb7f01129b63ec35a54857cb886b7.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/connecting-0f804651a891ef6112a51ba8b2e4d8dcb46e3462dcbc94e7b3c75bff20fc04e7.png +0 -0
- data/tools/staticdocs/assets/images/create_activity1-c05ffc03af2df852aeb3ad246f53f259af504e0e6c64cdac21f9126947c49f95.png +0 -0
- data/tools/staticdocs/assets/images/create_activity2-58c7da6f79dd510701148c0c54fae02c830b9ca4af662a7b132987ed3410a8f7.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata1-a331ba8f0bd19bf5f8d7f2e083c3c7164e9b7b9936f5a7f83c4141c62a6c46f6.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata2-c57b5420d5469b48289030ed7c64758539c2319dc742159caa0d4c8fe35050a8.png +0 -0
- data/tools/staticdocs/assets/images/create_note1-472b93e8e0e3e66a2e6198e0d4573cdc38cc356df87be66163f990f18137f6c0.png +0 -0
- data/tools/staticdocs/assets/images/create_note2-770501a149ef4aabae24d0b636f46ed61fbdcfda9537c61637c07c60257e9228.png +0 -0
- data/tools/staticdocs/assets/images/create_reaction1-a07e04677c269cb3eb5edd13bc7504ed6ba4c94f6a60d2b14a33680470d376fe.png +0 -0
- data/tools/staticdocs/assets/images/create_reaction2-63e4e9ddf06a2e8bc9911395162b5a05772f0756e8b0998bcecae64cf86c398e.png +0 -0
- data/tools/staticdocs/assets/images/create_reaction3-bae25e33640193d3dbbfbbfce6691479ccde16f73dbb3f0dc3023b7006259baa.png +0 -0
- data/tools/staticdocs/assets/images/create_trigger1-5e2f7ecf9ec2b7590aaa65503f48cd73549fea64f52e6c103370a408528538f6.png +0 -0
- data/tools/staticdocs/assets/images/create_trigger2-edf2c2e6aa78a2e317e07e1cdec560dfcbbd147934630459507695c71d539f3b.png +0 -0
- data/tools/staticdocs/assets/images/create_trigger3-e63629173ae73bbfd78b53062061336db8ea92ba4542b9a93412d8ac6ed19e7a.png +0 -0
- data/tools/staticdocs/assets/images/data_extractor-e0cd7006244f50f7d1811ee3f287b300aa3ccfb09f4716e1dd9990d1cc38a510.png +0 -0
- data/tools/staticdocs/assets/images/data_viewer-9eb6ce20988554325e15a6e404da9fef35b06c23548d5d136b4420f444ef94f7.png +0 -0
- data/tools/staticdocs/assets/images/debug-3103972d64395b50fff5808661fb846ae2de7d5934548ca5b88032f1ae12c541.png +0 -0
- data/tools/staticdocs/assets/images/delete_all_mouseover-e45ea88fcc088c18c88e03ddad5ad6fa9fa3869f67c1548bdfb3da447eceb228.png +0 -0
- data/tools/staticdocs/assets/images/delete_modified-ecf9beabf5e6cc6b8cc9d249ba9e313bd18d51c671ebc36029b4cebd729fa2d0.png +0 -0
- data/tools/staticdocs/assets/images/disable_trigger-f5bb46fbc488bd4afcb27b21888de16816485d3e4fdbd4106b874ff06042f85b.png +0 -0
- data/tools/staticdocs/assets/images/display_settings-726614b4eda5f74fc563e4d3b1798eb3893e152a15b9420a6053f6a2e0980944.png +0 -0
- data/tools/staticdocs/assets/images/edit_all_items-1de8be31edb8443427b834f03efea4ac5bceb722e5da0c0b38b2d006ff4364a7.png +0 -0
- data/tools/staticdocs/assets/images/edit_graph-9618076f837e0d358ea0bfbf503d43b377805d818370405536f5a1c049209e99.png +0 -0
- data/tools/staticdocs/assets/images/edit_screen-c655c75fe90429c0425b61cccf23835b6882975abaa56de21d58c9a4b19a4773.png +0 -0
- data/tools/staticdocs/assets/images/edit_temp1-545919bb22c6882d3b02cd4a4d8b9410b69e410c958b4472b8a643f48889f434.png +0 -0
- data/tools/staticdocs/assets/images/enabled_trigger-86ce16c7294d4b954ec8b68ff344694093ed5f451fc5974f855f438557148518.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-1c05cfc08f9d07b3f7122d2fe1ad98ed428dc563d2c5d2edddbed71f46779eb8.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-368e6f03ad620e01bf83fb991aace23312d45629bfcef2d3fbccd4dd9e4dbdbd.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-470589e527d9e82ce40e0c7d4a865e33d19b42350c2429dba97186d168137b6d.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-7880f656c65d1c95d94f11d85f83f1fb2cf1e743397022902485e1330467bdb4.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-8a0c6243e35822617229a729a598ace78e401b6c29f66eb5e07035d77d9be1aa.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-953e2fc0c1a5b30c90d6f748add6ee28f8b42f30fc33d0b3c8709d6c85f06585.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-d672c1f8064e5f847a2464397c1e75ee423452f1ba4a7d0861319bc7c7891196.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-d9ac5efbe78e58f024666452b9f28af72c6d09a3460fc7c0737c2bb74e4ea409.png +0 -0
- data/tools/staticdocs/assets/images/file_open-a5bc9e5ef73c12913ea4882498ceb52f93c73afaf5bb0c1083c4c1ee402f571d.png +0 -0
- data/tools/staticdocs/assets/images/float_minimize-a27fc649e517b279db5d2435fbd4f1de81418b9ef5f47fc83a9443bba0b1a7e0.png +0 -0
- data/tools/staticdocs/assets/images/four_graphs-1aa5a7cb9ce51cec815fc9d8740b40e113bd171c4977711d47ef1e6daf02719e.png +0 -0
- data/tools/staticdocs/assets/images/graph_menu-289cbbb168622f661c1c98a7bd2c1b43f888e9c3560ba4e1d435ab62d0aad6de.png +0 -0
- data/tools/staticdocs/assets/images/graph_min_max-75be4a19a7e13a1b9b7a18a9b898b170c8ded7768b01ce6c6effd566ac8e071a.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1-028d8660c779136ff017b0b8a9fadb294e9ff478a65d7bd73032c3c2ed4f03d0.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1_temp2-ad650da0ddf1fb5c6e9764b737bfab3027f5abcb935ad86d9716dfdf13032dca.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1_time-53c18518755d1d1c816db7f0a67e26c5408aba32b644fda519b5ecf7a7ee9b27.png +0 -0
- data/tools/staticdocs/assets/images/handbooks-948da6f5aad7a4175441235f2aac82668f9233c60412e412439b2e2af0bd1a45.png +0 -0
- data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
- data/tools/staticdocs/assets/images/ignored-0917bd9f41f4e93704daa45cc0a7b70809bdbba03615d6de254336141b598992.png +0 -0
- data/tools/staticdocs/assets/images/initial_reaction-ce5d498a90cdd5a11e24471d277ed7fcb4eecc5dcaaf05220102a3178db0805e.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/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png +0 -0
- data/tools/staticdocs/assets/images/limits_monitor-34ca441e5a7198b4dc57a27b2e6fcb973dddad5eaaa5e9bf0d60738f4143c73a.png +0 -0
- data/tools/staticdocs/assets/images/list_view-2f36ce06962e67d5a4f1f060956e5089b3f13c8ab57f33103c3781687611e7a9.png +0 -0
- data/tools/staticdocs/assets/images/log-6cf3276d9e6b7dc30573b2b6a5989c6c5defc658e2c0ae4c2150a5fd11fd49d3.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-6dd20c27f64fc00c8e61ee1062193fd6cb31efa4701130385c9853abfeed8495.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
- data/tools/staticdocs/assets/images/logs-bfc2ef93f6e60cb3bdf409aaaf0b4315b6e98dc1b9c17bdc171e67b416d884cc.png +0 -0
- data/tools/staticdocs/assets/images/minimized-47ddb9b9b68b47aae3d0a12cb39ab767adf446acbe213c0b5565c1bfaf8a463f.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-9ff9a2c1b2cae1eb15a7bd95c0d2bd939cf8f183a083edfcb2b70748dd1bbfe1.png +0 -0
- data/tools/staticdocs/assets/images/new_screen-0d9bea0538e91fa2332346f1ff73b1dda2e418d295dcd7d6a13ba240cf32187e.png +0 -0
- data/tools/staticdocs/assets/images/packet_viewer-505c517c9a838a41d6fe668ff7ca2efb1b89ced4b75df638cd11a45484bc6533.png +0 -0
- data/tools/staticdocs/assets/images/plugin_variables-6904e1d9003a6c8c530bd1f738f7966217beca7d3064b40670e7a4ab7e200927.png +0 -0
- data/tools/staticdocs/assets/images/processing-25c56ec1beef6f8df3db085378c31d2dd44289280414497d87ce8d12b4beebb9.png +0 -0
- data/tools/staticdocs/assets/images/processing_done-1d74097c066b6067e07a73735626dbff19f3102599c548b3874eb4f52ad5335d.png +0 -0
- data/tools/staticdocs/assets/images/project-c521374330008c1292b4da1b9a1c8af6647ab59f1617b470f26e76a521fe8059.png +0 -0
- data/tools/staticdocs/assets/images/raw_tlm_logs-b293435cebbd5d4f04ab8a469ce2b4eb66f4cfd046d7b18ee417893336816b85.png +0 -0
- data/tools/staticdocs/assets/images/reload_file-056b240b1d48539a9fecfe2ad1bac0c27d83f5dddcd29af6cf719986869406ee.png +0 -0
- data/tools/staticdocs/assets/images/reloaded-516bc4c257f9b7f6ce3714f5a06eeef8ad47a8461e21613ba26989d5e56260ec.png +0 -0
- data/tools/staticdocs/assets/images/running_scripts-694a1b310d42791acf64cf76ea370bb273084954107d5e6e2caf15f4fb50e634.png +0 -0
- data/tools/staticdocs/assets/images/script_error-2061222e00f5e5190a4407be1f8999200badca9b3137659de007e27cf1708dc0.png +0 -0
- data/tools/staticdocs/assets/images/script_menu-5a10df89d9806a59b41ef990fc1181c46c7ffa00496021efceb22c0f31dcc9cc.png +0 -0
- data/tools/staticdocs/assets/images/script_messages-5c30dab8202ae3d18fa1f12cdd43f409967b1d4ac84a4a0e96bf027041ab9a07.png +0 -0
- data/tools/staticdocs/assets/images/script_runner-31f6bfcb631b788ff0bf792ac21da30aaa503ca926b10a22d4337114effc28f0.png +0 -0
- data/tools/staticdocs/assets/images/script_suite-16647c3b3de01a8749f1b5c4ab2f8b452630df8c0470e5be38652acacfc98b5d.png +0 -0
- data/tools/staticdocs/assets/images/simple_screen-e3de1ad836c0661d73a0ba970f991c64df8ecc7e23f9e944b6508a9a43fbc33c.png +0 -0
- data/tools/staticdocs/assets/images/snoozed_reaction-75ef2acab11a71f5827fbc0a1be95cf0fd6bd5b24b76f9ae6ebaf43fb293ba81.png +0 -0
- data/tools/staticdocs/assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png +0 -0
- data/tools/staticdocs/assets/images/suite_checkboxes-af8452153dbc2143718fefcfc7d441e05f42c241b3c10d4f41200ae576f68063.png +0 -0
- data/tools/staticdocs/assets/images/table_manager-816d7a683e6883cb8049e5ec8ffef3076b37a489edcc0e5331bc5d81ab506da2.png +0 -0
- data/tools/staticdocs/assets/images/targets-77cde238fd55b2ed0a180ac2b906f6c1fe4677b22da718c455d61ac17c8a888f.png +0 -0
- data/tools/staticdocs/assets/images/telemetry_grapher-3a37c074a25b7912a76d96fd46a1431d27202d71374f78c829f273e5cb342233.png +0 -0
- data/tools/staticdocs/assets/images/telemetry_viewer-e4ac466930993a640f95aea4b01bb9a415eec77dfbfaa184f767cb59940ba943.png +0 -0
- data/tools/staticdocs/assets/images/temp1_details-4c4bbe7c2d60e636f0304ee8ac7237af8db2bdba8666c9ae2dc0a105eca248f2.png +0 -0
- data/tools/staticdocs/assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png +0 -0
- data/tools/staticdocs/assets/images/tlm_raw-cc2223b25e8fc732557856168fd7fa04e7b3459bbd163825639fb6235a8e6180.png +0 -0
- data/tools/staticdocs/assets/images/trigger_groups-6d9ccc6962029baa456f2d12de0fd3d03e1dbafdbf069cea65886296d2b2bde0.png +0 -0
- data/tools/staticdocs/assets/images/two_full_height-ccba2940b80345f3569ea47b7ddd3390c08195de91559f5586f85e36e411afd6.png +0 -0
- data/tools/staticdocs/assets/images/two_full_width-0116adbf994500a24d4717e002d32098f8d6197bcece510b84b90400f23feade.png +0 -0
- data/tools/staticdocs/assets/images/view_menu-a02cfbd5e6fafa5d3b4f1ae76bfbd63f49388939b4732bf91709f48e44498d19.png +0 -0
- data/tools/staticdocs/assets/js/0686a885.b4118c45.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.d4d5d4dc.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.f11f548e.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.53ec680c.js +1 -0
- data/tools/staticdocs/assets/js/12.afe230eb.js +1 -0
- data/tools/staticdocs/assets/js/13196248.1b40932b.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.a9ce7463.js +1 -0
- data/tools/staticdocs/assets/js/1670.3df3e214.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.cf71ed85.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.98364dbd.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.41136655.js +1 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.5133eebe.js +1 -0
- data/tools/staticdocs/assets/js/3df159b4.6c6b5f85.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.b31cf9ac.js +1 -0
- data/tools/staticdocs/assets/js/42170351.99726677.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.f9ce2508.js +1 -0
- data/tools/staticdocs/assets/js/{4657.9492019f.js → 4657.780d60d2.js} +2 -2
- data/tools/staticdocs/assets/js/54d0d530.29eb7035.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.37e9a690.js +1 -0
- data/tools/staticdocs/assets/js/{5bc719f6.3f10a4f9.js → 5bc719f6.80666891.js} +1 -1
- data/tools/staticdocs/assets/js/5e3ed378.c40da631.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.9938cdb0.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.176e2062.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.0db8db18.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.3b600a13.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.41b091e3.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.6078b2bb.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.7d9b46cc.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.76286adb.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.7aaf5f45.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.9077ef97.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.48e17a84.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.a33207e6.js +1 -0
- data/tools/staticdocs/assets/js/{aa6b6c1b.eb0299eb.js → aa6b6c1b.c81fb740.js} +1 -1
- data/tools/staticdocs/assets/js/b4596165.0d43540a.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.bd7af12d.js +1 -0
- data/tools/staticdocs/assets/js/{cd879be4.4b9bf792.js → cd879be4.5d8c0503.js} +1 -1
- data/tools/staticdocs/assets/js/d1bfc316.3ba6fac4.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.cd2d8652.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.d632d375.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.b9ed5eb0.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.002b1519.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.21aadf25.js +1 -0
- data/tools/staticdocs/assets/js/{ebec1ccb.15788749.js → ebec1ccb.4fc9c662.js} +1 -1
- data/tools/staticdocs/assets/js/fd886806.823bd757.js +1 -0
- data/tools/staticdocs/assets/js/main.f5f96e22.js +2 -0
- data/tools/staticdocs/assets/js/runtime~main.023a2c4f.js +1 -0
- data/tools/staticdocs/docs/configuration/command.html +25 -37
- data/tools/staticdocs/docs/configuration/format.html +5 -5
- data/tools/staticdocs/docs/configuration/interfaces.html +5 -5
- data/tools/staticdocs/docs/configuration/plugins.html +6 -7
- data/tools/staticdocs/docs/configuration/protocols.html +5 -5
- data/tools/staticdocs/docs/configuration/ssl-tls.html +5 -5
- data/tools/staticdocs/docs/configuration/table.html +11 -24
- data/tools/staticdocs/docs/configuration/target.html +5 -5
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +5 -5
- data/tools/staticdocs/docs/configuration/telemetry.html +5 -5
- data/tools/staticdocs/docs/configuration.html +5 -5
- data/tools/staticdocs/docs/development/curl.html +5 -5
- data/tools/staticdocs/docs/development/developing.html +5 -5
- data/tools/staticdocs/docs/development/host-install.html +5 -5
- data/tools/staticdocs/docs/development/json-api.html +5 -5
- data/tools/staticdocs/docs/development/log-structure.html +7 -7
- data/tools/staticdocs/docs/development/roadmap.html +5 -5
- data/tools/staticdocs/docs/development/streaming-api.html +5 -5
- data/tools/staticdocs/docs/development/testing.html +5 -5
- data/tools/staticdocs/docs/development.html +5 -5
- data/tools/staticdocs/docs/getting-started/generators.html +64 -0
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +6 -6
- data/tools/staticdocs/docs/getting-started/installation.html +7 -7
- data/tools/staticdocs/docs/getting-started/key_concepts.html +6 -6
- data/tools/staticdocs/docs/getting-started/podman.html +6 -6
- data/tools/staticdocs/docs/getting-started/requirements.html +7 -7
- data/tools/staticdocs/docs/getting-started/upgrading.html +6 -6
- data/tools/staticdocs/docs/getting-started.html +5 -5
- data/tools/staticdocs/docs/guides/bridges.html +5 -5
- data/tools/staticdocs/docs/guides/cfs.html +9 -12
- data/tools/staticdocs/docs/guides/custom-widgets.html +7 -7
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +5 -5
- data/tools/staticdocs/docs/guides/local-mode.html +10 -13
- data/tools/staticdocs/docs/guides/logging.html +12 -16
- data/tools/staticdocs/docs/guides/monitoring.html +5 -5
- data/tools/staticdocs/docs/guides/performance.html +5 -5
- data/tools/staticdocs/docs/guides/raspberrypi.html +5 -5
- data/tools/staticdocs/docs/guides/script-writing.html +7 -9
- data/tools/staticdocs/docs/guides/scripting-api.html +6 -6
- data/tools/staticdocs/docs/guides.html +5 -5
- data/tools/staticdocs/docs/meta/contributing.html +6 -6
- data/tools/staticdocs/docs/meta/licenses.html +89 -0
- data/tools/staticdocs/docs/meta/philosophy.html +6 -6
- data/tools/staticdocs/docs/meta/xtce.html +6 -6
- data/tools/staticdocs/docs/meta.html +5 -5
- data/tools/staticdocs/docs/privacy.html +5 -5
- data/tools/staticdocs/docs/tools/autonomic.html +30 -14
- data/tools/staticdocs/docs/tools/bucket-explorer.html +8 -7
- data/tools/staticdocs/docs/tools/calendar.html +29 -32
- data/tools/staticdocs/docs/tools/cmd-sender.html +12 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +15 -15
- data/tools/staticdocs/docs/tools/data-extractor.html +23 -33
- data/tools/staticdocs/docs/tools/data-viewer.html +14 -14
- data/tools/staticdocs/docs/tools/handbooks.html +6 -6
- data/tools/staticdocs/docs/tools/limits-monitor.html +29 -15
- data/tools/staticdocs/docs/tools/packet-viewer.html +18 -15
- data/tools/staticdocs/docs/tools/script-runner.html +36 -30
- data/tools/staticdocs/docs/tools/table-manager.html +7 -7
- data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -23
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- data/tools/staticdocs/docs/tools.html +5 -5
- data/tools/staticdocs/docs.html +5 -5
- data/tools/staticdocs/img/autonomic/autonomic.png +0 -0
- data/tools/staticdocs/img/autonomic/create_reaction1.png +0 -0
- data/tools/staticdocs/img/autonomic/create_reaction2.png +0 -0
- data/tools/staticdocs/img/autonomic/create_reaction3.png +0 -0
- data/tools/staticdocs/img/autonomic/create_trigger1.png +0 -0
- data/tools/staticdocs/img/autonomic/create_trigger2.png +0 -0
- data/tools/staticdocs/img/autonomic/create_trigger3.png +0 -0
- data/tools/staticdocs/img/autonomic/disable_trigger.png +0 -0
- data/tools/staticdocs/img/autonomic/enabled_trigger.png +0 -0
- data/tools/staticdocs/img/autonomic/initial_reaction.png +0 -0
- data/tools/staticdocs/img/autonomic/snoozed_reaction.png +0 -0
- data/tools/staticdocs/img/autonomic/trigger_groups.png +0 -0
- data/tools/staticdocs/img/bucket_explorer/bucket_explorer.png +0 -0
- data/tools/staticdocs/img/calendar/blank_calendar.png +0 -0
- data/tools/staticdocs/img/calendar/calendar.png +0 -0
- data/tools/staticdocs/img/calendar/create_activity1.png +0 -0
- data/tools/staticdocs/img/calendar/create_activity2.png +0 -0
- data/tools/staticdocs/img/calendar/create_metadata1.png +0 -0
- data/tools/staticdocs/img/calendar/create_metadata2.png +0 -0
- data/tools/staticdocs/img/calendar/create_note1.png +0 -0
- data/tools/staticdocs/img/calendar/create_note2.png +0 -0
- data/tools/staticdocs/img/calendar/list_view.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_packets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_raw.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/file_menu.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/interfaces.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/routers.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/status.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/targets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/tlm_packets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/tlm_raw.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/data_extractor/add_item.png +0 -0
- data/tools/staticdocs/img/data_extractor/add_packet.png +0 -0
- data/tools/staticdocs/img/data_extractor/add_target.png +0 -0
- data/tools/staticdocs/img/data_extractor/data_extractor.png +0 -0
- data/tools/staticdocs/img/data_extractor/delete_all_mouseover.png +0 -0
- data/tools/staticdocs/img/data_extractor/edit_all_items.png +0 -0
- data/tools/staticdocs/img/data_extractor/edit_all_mouseover.png +0 -0
- data/tools/staticdocs/img/data_extractor/edit_temp1.png +0 -0
- data/tools/staticdocs/img/data_extractor/file_menu.png +0 -0
- data/tools/staticdocs/img/data_extractor/mode_menu.png +0 -0
- data/tools/staticdocs/img/data_extractor/processing.png +0 -0
- data/tools/staticdocs/img/data_extractor/processing_done.png +0 -0
- data/tools/staticdocs/img/data_viewer/add_component.png +0 -0
- data/tools/staticdocs/img/data_viewer/data_viewer.png +0 -0
- data/tools/staticdocs/img/data_viewer/display_settings.png +0 -0
- data/tools/staticdocs/img/data_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/generator/plugin_files.png +0 -0
- data/tools/staticdocs/img/generator/target_files.png +0 -0
- data/tools/staticdocs/img/guides/local_mode/delete_modified.png +0 -0
- data/tools/staticdocs/img/guides/local_mode/project.png +0 -0
- data/tools/staticdocs/img/guides/local_mode/reload_file.png +0 -0
- data/tools/staticdocs/img/guides/local_mode/reloaded.png +0 -0
- data/tools/staticdocs/img/guides/logging/log_messages.png +0 -0
- data/tools/staticdocs/img/guides/logging/logs.png +0 -0
- data/tools/staticdocs/img/guides/logging/raw_tlm_logs.png +0 -0
- data/tools/staticdocs/img/guides/logging/script_messages.png +0 -0
- data/tools/staticdocs/img/guides/plugin_variables.png +0 -0
- data/tools/staticdocs/img/guides/simple_screen.png +0 -0
- data/tools/staticdocs/img/handbooks/handbooks.png +0 -0
- data/tools/staticdocs/img/limits_monitor/change_limits_set.png +0 -0
- data/tools/staticdocs/img/limits_monitor/file_menu.png +0 -0
- data/tools/staticdocs/img/limits_monitor/ignored.png +0 -0
- data/tools/staticdocs/img/limits_monitor/limits_monitor.png +0 -0
- data/tools/staticdocs/img/limits_monitor/log.png +0 -0
- data/tools/staticdocs/img/packet_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/packet_viewer/packet_viewer.png +0 -0
- data/tools/staticdocs/img/packet_viewer/temp1_details.png +0 -0
- data/tools/staticdocs/img/packet_viewer/view_menu.png +0 -0
- data/tools/staticdocs/img/script_runner/checks_rb.png +0 -0
- data/tools/staticdocs/img/script_runner/connecting.png +0 -0
- data/tools/staticdocs/img/script_runner/debug.png +0 -0
- data/tools/staticdocs/img/script_runner/edit_menu.png +0 -0
- data/tools/staticdocs/img/script_runner/file_menu.png +0 -0
- data/tools/staticdocs/img/script_runner/file_open.png +0 -0
- data/tools/staticdocs/img/script_runner/running_scripts.png +0 -0
- data/tools/staticdocs/img/script_runner/script_error.png +0 -0
- data/tools/staticdocs/img/script_runner/script_menu.png +0 -0
- data/tools/staticdocs/img/script_runner/script_runner.png +0 -0
- data/tools/staticdocs/img/script_runner/script_suite.png +0 -0
- data/tools/staticdocs/img/script_runner/suite_checkboxes.png +0 -0
- data/tools/staticdocs/img/table_manager/file_menu.png +0 -0
- data/tools/staticdocs/img/table_manager/table_manager.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/edit_graph.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/file_menu.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/four_graphs.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/graph_menu.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/graph_min_max.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/graph_temp1.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/graph_temp1_temp2.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/graph_temp1_time.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/minimized.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/telemetry_grapher.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/two_full_height.png +0 -0
- data/tools/staticdocs/img/telemetry_grapher/two_full_width.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/edit_screen.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/float_minimize.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/new_screen.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/telemetry_viewer.png +0 -0
- data/tools/staticdocs/index.html +5 -5
- data/tools/staticdocs/lunr-index-1705623764307.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +5 -5
- data/tools/staticdocs/search-doc-1705623764307.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +277 -261
- data/tools/staticdocs/assets/css/styles.6e885bef.css +0 -1
- data/tools/staticdocs/assets/images/add_packet-f318d0e92e8a13bd56331350aa341c88c8b12f2c54a4424f6e287817f22fb327.png +0 -0
- data/tools/staticdocs/assets/images/autonomic-3d6d152f700c8fc1878d0f952d013ace31fccd7872d28587dc761610a0959e9c.png +0 -0
- data/tools/staticdocs/assets/images/bucket_explorer-983c087ee3bdcf8626219e782620b6c580fd82bfe2e8b0c662a0f90cdca43838.png +0 -0
- data/tools/staticdocs/assets/images/calendar-9fbd635cf3df1ba684bb0c1ebc4f6ad34991efc582e9fd07820c8b74cbb66aa1.png +0 -0
- data/tools/staticdocs/assets/images/checks_rb-a6049cdd99613cea2ee12d76fcfe798ff05270e39d208e93d37da7347049b2b3.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-313e3f64afc0e374d9d28b46364235d7b793001f84690fc0ae90e1eefdd9142d.png +0 -0
- data/tools/staticdocs/assets/images/command_sender-a0b113b65368263529d0f8f2d93276a0a44ed81af0d0100f56379346ba592928.png +0 -0
- data/tools/staticdocs/assets/images/commands-3608d5c856fd34e771d1f9e69f9f449f52929249bdf4f0e7feed0aa2bd2d9fd7.png +0 -0
- data/tools/staticdocs/assets/images/connecting-6e453f3d99800d4cb8fdc78f5b8fce1e8cf1bb04840a29dec7c5caefd07c004f.png +0 -0
- data/tools/staticdocs/assets/images/data_extractor-62c5b1743ba9dfdff2e393bcbdf863c36effc5ef5319d845cfd17186bd757bca.png +0 -0
- data/tools/staticdocs/assets/images/data_viewer-8c547cb5ad2ebd179aac5e46c2f4c147889ebad53a5359a5e6b6c580de7184fe.png +0 -0
- data/tools/staticdocs/assets/images/date_chooser-10f7b740b9acc76604e5dc86fe409b6b777abe0fb3fa5ebf8f47cb1ac58b9676.png +0 -0
- data/tools/staticdocs/assets/images/debug-04088348cc04bb8e1a1063fc44920dc8e39616840ef4b09a36c823f185c28669.png +0 -0
- data/tools/staticdocs/assets/images/delete_all_mouseover-06083f3d3d712d39f21bc5eda45adbfff449732a2061e53cb1a0baf6c5f5d4b8.png +0 -0
- data/tools/staticdocs/assets/images/delete_modified-a7ec0ceb61c37398d57fcecf11ebe2453ebd0110be6cfc960a5073a13a557638.png +0 -0
- data/tools/staticdocs/assets/images/edit_all_items-2c57aff19d3b1ce52149c37f50dcaad8c30baa0c9931fdc629f1d163bb56ce96.png +0 -0
- data/tools/staticdocs/assets/images/edit_all_mouseover-f6646df5320045ee10d4c0a15d0349fed6ede075f9cea6f9e449b3785c4f4f8d.png +0 -0
- data/tools/staticdocs/assets/images/edit_graph-4ca61635376fae26cf5eb82fb9fd803f1a51c4d3584aaf9833a270b7916bf531.png +0 -0
- data/tools/staticdocs/assets/images/edit_screen-5724ae13958c1631b3c187cf7cdb6dc9672ecd71f8b0786ac17c0266001edac3.png +0 -0
- data/tools/staticdocs/assets/images/edit_temp1-7446e7c5b7869ccc9ddd467779fa86f44301a5e5896751b016a527587c483cb2.png +0 -0
- data/tools/staticdocs/assets/images/file_menu-2fe13872737c0f3fef84ba5b58b80b609082733acce536ec1f56910c36f68299.png +0 -0
- data/tools/staticdocs/assets/images/file_open-319761fd383fc513b3689ef0a7498c73ce9459a3967c8a395cc2da07c89240d0.png +0 -0
- data/tools/staticdocs/assets/images/file_save_as-44468ed6a48bea3bc4fdd8f50d802569e4582b453e5bf946bfdcba400030d499.png +0 -0
- data/tools/staticdocs/assets/images/four_graphs-826cf8145338fa46e037556df94c59aeb4448330b601953daa94c89de8494cfd.png +0 -0
- data/tools/staticdocs/assets/images/graph_min_max-80a2bd83230c71b00ba9d6da24b8c32a09e4983976cdbf32c33d2680b534b106.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1-de937a79b314cf856b783c936d2460a6c942bdd45e4d9b3fe488957df5bfa9bc.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1_temp2-e96370f7d73a6cb68beaa92bcaaf18b72e6619ce948fe835762cca1048efbd18.png +0 -0
- data/tools/staticdocs/assets/images/graph_temp1_time-fec5e99e3cc05ea87208abe9c4b66b63b7497bbefee55f65d034417e966b1c46.png +0 -0
- data/tools/staticdocs/assets/images/handbooks-1d301c83c80a7cb96c548006f5139fe8ec967ed10a49df0142b37328cd987f33.png +0 -0
- data/tools/staticdocs/assets/images/ignored-1e20d4ffe7fd88ffab610340957b1176294269f985e8fdb20a9af07d7a78215f.png +0 -0
- data/tools/staticdocs/assets/images/inst_clear-5ecb859f06f14d91d2ebba27e5a7848d6393db5ad2357f95c12e776c45f6bc64.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect-4f4e453a6521b779e10c4d2be6a8b1acf15fcb083af0164b0df1de27ca250132.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous-3aeabedb96bf114b4eb56b6b2ee7bcc601302ec8905a82a16c47ae7870f97978.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous_history-952a6e6ff2fb1b5fdf2c6b3d84a3ccf9e303eeb310f35514dc4a6e95f2a7420e.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_sent-0de429f724264ce8c52a6cb22d4bbb96f14e22b559c091ff4375bb59f124a7a2.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_sent_3-91cf4e053d246917964330ab93534a0a5eb878b652e7ea879effca7c4eaefbea.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-5622abf50e3df63980661a48216bf71187f38cb636bd512f48917ca4a425f083.png +0 -0
- data/tools/staticdocs/assets/images/items_table-2fc1bb4d03a2348c4af7df442e13cee2f310cf455228005d76cbfda7a706aa53.png +0 -0
- data/tools/staticdocs/assets/images/items_table_raw-c4d454679c4503ec35710dcee6be5cd1940984595145b333d8604bc505dfe291.png +0 -0
- data/tools/staticdocs/assets/images/items_table_temp1-ea091eaf8005cea839800f4514f72f94e9664993111b935f33e7c5aa3061ca64.png +0 -0
- data/tools/staticdocs/assets/images/limits_monitor-c58d70daea7586b93d5069b9df068a90cea5f7cf2e51a445f3162bf3f66db3d0.png +0 -0
- data/tools/staticdocs/assets/images/list_view-926f42bc1e43283c61616b0cd8fd630cad8e15c9b7298acd98536842472e673b.png +0 -0
- data/tools/staticdocs/assets/images/log-ba64fd307e53adafae55fcea7eb31829ee1aacdf4aafe8b40b270b793be3aa27.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-19c3ce9c7ff86e43d459cb6591df8c05d25e1390d857728cb462a57b9d3ccc69.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-2cfad0fd6f6f980f69b5564a4b7ecfecf3331c6256c78bcfb2b084970db305ca.png +0 -0
- data/tools/staticdocs/assets/images/minimized-59d0d8d8a179ff0475787e87237b77b24d59d78826d43dbc1a554a51380eb37f.png +0 -0
- data/tools/staticdocs/assets/images/minimized-a658bd8f2115d3f9a386844e886de770b23bbf9c0c8c55a4ca587cea67ec320e.png +0 -0
- data/tools/staticdocs/assets/images/minio-150460ac77a50711835de6f0150d019000e5515afae0f3adfcdda8e891484f47.png +0 -0
- data/tools/staticdocs/assets/images/mouseover-95b774047b3c2ca23a3bc645caf75d90511c378729dd9cfb781510a1452e09fe.png +0 -0
- data/tools/staticdocs/assets/images/new_screen-295720ec60219194c8c8dd64c755e8a188cc4a68c2b6cf66197b54514644d52a.png +0 -0
- data/tools/staticdocs/assets/images/notifications-5b32d6619542431027ddd67491eb445469fa2d16fa8352a2b0917b9298b7bbb2.png +0 -0
- data/tools/staticdocs/assets/images/open_config-2e61415a3c2d7a4ce427cf325f3708dd4a761092b7dd0c869279c4354dc34ae4.png +0 -0
- data/tools/staticdocs/assets/images/open_config-3cd3be1ce4560d9e72bb37b83dc830149091dec9a088c36187e0e72660c6ec34.png +0 -0
- data/tools/staticdocs/assets/images/open_config-55ef2f241d02047b252bb8201742f99cffed5680d0e9eb46b3cb53a644ca3dc9.png +0 -0
- data/tools/staticdocs/assets/images/open_config-f848a8b371ae0ec31776834148e9f978d9be94efef03534e5ca3a59c0ae3847f.png +0 -0
- data/tools/staticdocs/assets/images/packet_viewer-19c1015cc704a98d1f6d90dd0dadc13188d25f1d5d2e838b7cfb226e8c173c7b.png +0 -0
- data/tools/staticdocs/assets/images/plugin-variables-5bc00c744182c9a9591e84cb3bbb1c4deb53ff22e05f62ce1b807c26bed782e5.png +0 -0
- data/tools/staticdocs/assets/images/processing-b0c50908284739a76e1bbcfcb3eb34dc9446f8716117cb0e9089ad9df53ebed6.png +0 -0
- data/tools/staticdocs/assets/images/project-fe7ac90f3e45971fca8f1be94be9dbabe494bafe705e7f8f485676e9d96e47ea.png +0 -0
- data/tools/staticdocs/assets/images/project_update-8e7de3b0658b95d4d9931eb52ff8bf339d633cbdc273ce096eb11ceb357c009e.png +0 -0
- data/tools/staticdocs/assets/images/raw_command-759d93759a73a6a3dd7e30f89fc4d1a544dfb6f7355abfed03897d404279161d.png +0 -0
- data/tools/staticdocs/assets/images/raw_telemetry-ffeb6b603f9a9abbe0cb77afaaeb4b4f07dfee479682a5c9661f85589a679049.png +0 -0
- data/tools/staticdocs/assets/images/raw_tlm_logs-8dcba4f020b36f8efbb793271b70d40d9cad627196afaeb5bf6f3931ed53fa52.png +0 -0
- data/tools/staticdocs/assets/images/reactions-dd4a8ebf22eed921a82a5478d23178c62e2cf944d295c2b9e3f4d7ce555b0fcc.png +0 -0
- data/tools/staticdocs/assets/images/reload_file-8e26cd3e1bc1eab7bb6c046d9a6a8231fcd76e56682d819b1e549182890c6486.png +0 -0
- data/tools/staticdocs/assets/images/reloaded-9effa15527244928ee503eb0c3a48cc5e82c07cfb5d5c4300eacfcab913069d1.png +0 -0
- data/tools/staticdocs/assets/images/running_scripts-78bfd36a6c8c7167234e03bd188e974927c2beea1f730498583169a81639e7a3.png +0 -0
- data/tools/staticdocs/assets/images/save_config-0ae36ac1f8114665f2558e936ba3b30e5cba2a16cc01d3494e14ed689b4637f7.png +0 -0
- data/tools/staticdocs/assets/images/save_config-8b028134b07c70d6de019825cbb328623fc485d72aad9ba5b1980246b316fec2.png +0 -0
- data/tools/staticdocs/assets/images/save_config-e4ed80276ebdc2c4eaf9aaeb859cff8aecb380b22da8c659741c31ca66914098.png +0 -0
- data/tools/staticdocs/assets/images/save_config-e748a338526ffd8f9e49def5c0d15f8a80cd987f40d210ff6c6d4b61b713555c.png +0 -0
- data/tools/staticdocs/assets/images/script_error-ce060b3086e7b466e51a276fb6b27245b4d042f07a60fe121b0071dd65a42075.png +0 -0
- data/tools/staticdocs/assets/images/script_runner-7d7f01b90be962b4de46c20568727c55488eec5d9844823b53a262c9cfc470fa.png +0 -0
- data/tools/staticdocs/assets/images/script_suite-42832d936f91417740b76a39841996c8e4a7cf5391dbb19abe9d7b31ab07dd7d.png +0 -0
- data/tools/staticdocs/assets/images/select_item-f063106a8d836656496ba81e7e7428f51bd8ab95aebab0aa4eb6ad41ed42e026.png +0 -0
- data/tools/staticdocs/assets/images/select_packet-0b6d5a2b012445ab2bf0fd3e1545f015cd7787280d05d2bccb0a9c9220102529.png +0 -0
- data/tools/staticdocs/assets/images/select_packet-be9d63c49f898cccb73f9e4b2b39c4b5879cead34a8ab2ede0bb08e953498e95.png +0 -0
- data/tools/staticdocs/assets/images/select_target-71ebcab6cbefafd8958939130861a75f7544e99a043d90fa0734ec2f983d835f.png +0 -0
- data/tools/staticdocs/assets/images/simple_screen-3c9d6d2366c716c03a301396a4ce0ea418532890f349d9bc9ebb8be90983a6e6.png +0 -0
- data/tools/staticdocs/assets/images/status-80010882300d2f1c453fbc4cb35bdb1f06d3db578266dda95c56ea7ec230ac72.png +0 -0
- data/tools/staticdocs/assets/images/table_manager-9a5357ce536102bc1bb0c859be552f4ac82f62e538935a3c45a8e76d4f9744db.png +0 -0
- data/tools/staticdocs/assets/images/targets-d15296b133787be4997c3d5e7d43eec9030831f1758508a8f6a71d40d04478ce.png +0 -0
- data/tools/staticdocs/assets/images/telemetry-3f1169fc67b3d2427047ba66a9b2f3ddf71f61edf498ee70d14e78f0ef3c1e3c.png +0 -0
- data/tools/staticdocs/assets/images/telemetry_grapher-a96b7e0101f5e377a73a186683e967e79d748c5dff2dfed6ec0afcea5694d7c8.png +0 -0
- data/tools/staticdocs/assets/images/telemetry_viewer-be6ee576f1efceb39c2f744889deb4c18f571c4922c69d5d0e5f49a653776a46.png +0 -0
- data/tools/staticdocs/assets/images/temp1_details-f0b6e62bc28da18febacc936112735e1dbd5718ef675668f04d8b3e060d7f87a.png +0 -0
- data/tools/staticdocs/assets/images/time_chooser-e4ca0705d5b97c3056b0de3ab7f71f8091482b9b2e8904e69866a43ce4e616f2.png +0 -0
- data/tools/staticdocs/assets/images/triggers-0b0b3f9cc2850c1b83b9a7aab6f8a936626fd847c3158e993e4baa0e64b38096.png +0 -0
- data/tools/staticdocs/assets/images/two_full_height-7cf9d0bbdf0269ad85e312f6dcb77930e1e3c4319f9750968a9347fafcf26084.png +0 -0
- data/tools/staticdocs/assets/images/two_full_width-db2d88c0e2e6fc417016f47e3bac0bf68374957d8fc014220f53870429ea1ef3.png +0 -0
- data/tools/staticdocs/assets/images/view_portal-b2e5fef00be80f1551b965d170fc3cd8ed95597f0a1e475a8177ab2d306215f5.png +0 -0
- data/tools/staticdocs/assets/images/view_portal_add-56f06135fc56f1fa85cbc22ea3b7ad52f311641aad25df08b6f4a6f979b30e3f.png +0 -0
- data/tools/staticdocs/assets/js/0686a885.4e302d8a.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.d985bc97.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.e271df4e.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.4cf4eeb0.js +0 -1
- data/tools/staticdocs/assets/js/12.ef103c80.js +0 -1
- data/tools/staticdocs/assets/js/13196248.51e9b91e.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.82c72cb7.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.fd40457e.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.a77dc1e7.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.e063c83a.js +0 -1
- data/tools/staticdocs/assets/js/3df159b4.7047e215.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.cfe2d836.js +0 -1
- data/tools/staticdocs/assets/js/42170351.cee0ce87.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.a68af7c2.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.ae86bb53.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.98a98907.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.943a1325.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.677fead8.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.f17d074a.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.1691ed32.js +0 -1
- data/tools/staticdocs/assets/js/7158.db39a041.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.895d48ed.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.a5199202.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.52676c0c.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.da0a4de8.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.5069508d.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.d6c28a4e.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.9a3ba2db.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.e1bf97fd.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.d2ef4105.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.9ca026be.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.f860e15e.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.c1e1579f.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.cd5125b1.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.c1a3930b.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.87e69867.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.64985b23.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.5a283ff8.js +0 -1
- data/tools/staticdocs/assets/js/main.1b3209ca.js +0 -2
- data/tools/staticdocs/assets/js/runtime~main.6ca622b3.js +0 -1
- data/tools/staticdocs/img/v5/autonomic/autonomic.png +0 -0
- data/tools/staticdocs/img/v5/autonomic/reactions.png +0 -0
- data/tools/staticdocs/img/v5/autonomic/triggers.png +0 -0
- data/tools/staticdocs/img/v5/bucket_explorer/bucket_explorer.png +0 -0
- data/tools/staticdocs/img/v5/calendar/calendar.png +0 -0
- data/tools/staticdocs/img/v5/calendar/list_view.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/commands.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/interfaces.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/log_messages.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/raw_command.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/raw_telemetry.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/routers.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/status.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/targets.png +0 -0
- data/tools/staticdocs/img/v5/cmd_tlm_server/telemetry.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/command_sender.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/inst_clear.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/inst_collect.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/inst_collect_hazardous.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/inst_collect_sent.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/inst_collect_sent_3.png +0 -0
- data/tools/staticdocs/img/v5/command_sender/mode_menu.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/data_extractor.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/date_chooser.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/delete_all_mouseover.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/download.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/edit_all_items.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/edit_all_mouseover.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/edit_temp1.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/items_table.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/items_table_raw.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/items_table_temp1.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/mode_menu.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/open_config.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/processing.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/save_config.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/select_item.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/select_packet.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/select_target.png +0 -0
- data/tools/staticdocs/img/v5/data_extractor/time_chooser.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/add_packet.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/data_viewer.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/open_config.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/rename_tab.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/save_config.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/tab_right_click.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/view_portal.png +0 -0
- data/tools/staticdocs/img/v5/data_viewer/view_portal_add.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/delete_modified.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/minio.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/project.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/project_update.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/reload_file.png +0 -0
- data/tools/staticdocs/img/v5/guides/local_mode/reloaded.png +0 -0
- data/tools/staticdocs/img/v5/guides/logging/browser.png +0 -0
- data/tools/staticdocs/img/v5/guides/logging/log_messages.png +0 -0
- data/tools/staticdocs/img/v5/guides/logging/notifications.png +0 -0
- data/tools/staticdocs/img/v5/guides/logging/raw_tlm_logs.png +0 -0
- data/tools/staticdocs/img/v5/guides/plugin-variables.png +0 -0
- data/tools/staticdocs/img/v5/guides/simple_screen.png +0 -0
- data/tools/staticdocs/img/v5/handbooks/handbooks.png +0 -0
- data/tools/staticdocs/img/v5/limits_monitor/ignored.png +0 -0
- data/tools/staticdocs/img/v5/limits_monitor/limits_monitor.png +0 -0
- data/tools/staticdocs/img/v5/limits_monitor/log.png +0 -0
- data/tools/staticdocs/img/v5/limits_monitor/mouseover.png +0 -0
- data/tools/staticdocs/img/v5/navigation.png +0 -0
- data/tools/staticdocs/img/v5/packet_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/packet_viewer/packet_viewer.png +0 -0
- data/tools/staticdocs/img/v5/packet_viewer/select_packet.png +0 -0
- data/tools/staticdocs/img/v5/packet_viewer/temp1_details.png +0 -0
- data/tools/staticdocs/img/v5/packet_viewer/view_menu.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/checks_rb.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/connecting.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/debug.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/file_open.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/running_scripts.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/script_error.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/script_menu.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/script_runner.png +0 -0
- data/tools/staticdocs/img/v5/script_runner/script_suite.png +0 -0
- data/tools/staticdocs/img/v5/table_manager/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/table_manager/table_manager.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/edit_graph.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/four_graphs.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/graph_menu.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/graph_min_max.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/graph_temp1.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/graph_temp1_temp2.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/graph_temp1_time.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/minimized.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/open_config.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/save_config.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/telemetry_grapher.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/two_full_height.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_grapher/two_full_width.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/edit_screen.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/file_menu.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/minimized.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/new_screen.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/open_config.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/save_config.png +0 -0
- data/tools/staticdocs/img/v5/telemetry_viewer/telemetry_viewer.png +0 -0
- data/tools/staticdocs/lunr-index-1702922896263.json +0 -1
- data/tools/staticdocs/search-doc-1702922896263.json +0 -1
- /data/tools/staticdocs/assets/js/{4657.9492019f.js.LICENSE.txt → 4657.780d60d2.js.LICENSE.txt} +0 -0
- /data/tools/staticdocs/assets/js/{main.1b3209ca.js.LICENSE.txt → main.f5f96e22.js.LICENSE.txt} +0 -0
- /data/tools/staticdocs/img/{v5/architecture.png → architecture.png} +0 -0
- /data/tools/staticdocs/img/{v5/calendar → calendar}/timeline_lifecycle.png +0 -0
- /data/tools/staticdocs/img/{v5/command_sender → command_sender}/inst_collect_hazardous_history.png +0 -0
- /data/tools/staticdocs/img/{v5/contact → contact}/jason.png +0 -0
- /data/tools/staticdocs/img/{v5/contact → contact}/ryan.jpeg +0 -0
- /data/tools/staticdocs/img/{v5/script_runner → script_runner}/file_save_as.png +0 -0
- /data/tools/staticdocs/img/{v5/telemetry_grapher → telemetry_grapher}/grapher_controls.png +0 -0
- /data/tools/staticdocs/img/{v5/telemetry_grapher → telemetry_grapher}/stop_start.png +0 -0
@@ -2,10 +2,10 @@
|
|
2
2
|
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/raspberrypi" data-has-hydrated="false">
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
|
-
<meta name="generator" content="Docusaurus v3.
|
6
|
-
<title data-rh="true">Raspberry Pi | 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/guides/raspberrypi"><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="Raspberry Pi | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS Running on Raspberry Pi 4"><meta data-rh="true" property="og:description" content="COSMOS Running on Raspberry Pi 4"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
5
|
+
<meta name="generator" content="Docusaurus v3.1.0">
|
6
|
+
<title data-rh="true">Raspberry Pi | 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/guides/raspberrypi"><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="Raspberry Pi | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS Running on Raspberry Pi 4"><meta data-rh="true" property="og:description" content="COSMOS Running on Raspberry Pi 4"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/raspberrypi" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.dd31dbff.css">
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.023a2c4f.js" defer="defer"></script>
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.f5f96e22.js" defer="defer"></script>
|
9
9
|
</head>
|
10
10
|
<body class="navigation-with-keyboard">
|
11
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 localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" 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" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" 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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" 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" aria-expanded="true" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Collapse sidebar category 'Guides'" 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/guides/bridges">Bridges</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/guides/cfs">COSMOS and NASA cFS</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/guides/custom-widgets">Custom Widgets</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/guides/little-endian-bitfields">Little Endian Bitfields</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/guides/local-mode">Local Mode</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/guides/logging">Logging</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/guides/monitoring">Monitoring</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/guides/performance">Performance</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/guides/raspberrypi">Raspberry Pi</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/guides/script-writing">Script Writing Guide</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/guides/scripting-api">Scripting API Guide</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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" 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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" 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/guides"><span itemprop="name">Guides</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">Raspberry Pi</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>Raspberry Pi</h1></header><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cosmos-running-on-raspberry-pi-4">COSMOS Running on Raspberry Pi 4<a href="#cosmos-running-on-raspberry-pi-4" class="hash-link" aria-label="Direct link to COSMOS Running on Raspberry Pi 4" title="Direct link to COSMOS Running on Raspberry Pi 4"></a></h3>
|
@@ -76,6 +76,6 @@
|
|
76
76
|
<li>
|
77
77
|
<p>Congratulations! You now have COSMOS running on a Raspberry Pi!</p>
|
78
78
|
</li>
|
79
|
-
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/raspberrypi.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_T23F"></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/guides/performance"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Performance</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/guides/script-writing"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Script Writing Guide</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="#cosmos-running-on-raspberry-pi-4" class="table-of-contents__link toc-highlight">COSMOS Running on Raspberry Pi 4</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 ©
|
79
|
+
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/raspberrypi.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_T23F"></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/guides/performance"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Performance</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/guides/script-writing"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Script Writing Guide</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="#cosmos-running-on-raspberry-pi-4" class="table-of-contents__link toc-highlight">COSMOS Running on Raspberry Pi 4</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>
|
80
80
|
</body>
|
81
81
|
</html>
|
@@ -2,10 +2,10 @@
|
|
2
2
|
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/script-writing" data-has-hydrated="false">
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
|
-
<meta name="generator" content="Docusaurus v3.
|
6
|
-
<title data-rh="true">Script Writing Guide | 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/guides/script-writing"><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="Script Writing Guide | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
5
|
+
<meta name="generator" content="Docusaurus v3.1.0">
|
6
|
+
<title data-rh="true">Script Writing Guide | 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/guides/script-writing"><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="Script Writing Guide | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/script-writing" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.dd31dbff.css">
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.023a2c4f.js" defer="defer"></script>
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.f5f96e22.js" defer="defer"></script>
|
9
9
|
</head>
|
10
10
|
<body class="navigation-with-keyboard">
|
11
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 localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" 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" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" 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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" 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" aria-expanded="true" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Collapse sidebar category 'Guides'" 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/guides/bridges">Bridges</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/guides/cfs">COSMOS and NASA cFS</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/guides/custom-widgets">Custom Widgets</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/guides/little-endian-bitfields">Little Endian Bitfields</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/guides/local-mode">Local Mode</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/guides/logging">Logging</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/guides/monitoring">Monitoring</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/guides/performance">Performance</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/guides/raspberrypi">Raspberry Pi</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/guides/script-writing">Script Writing Guide</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/guides/scripting-api">Scripting API Guide</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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" 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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" 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/guides"><span itemprop="name">Guides</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">Script Writing Guide</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>Script Writing Guide</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="introduction">Introduction<a href="#introduction" class="hash-link" aria-label="Direct link to Introduction" title="Direct link to Introduction"></a></h2>
|
@@ -111,9 +111,7 @@
|
|
111
111
|
<p>All scripts must be part of a <a href="/tools/staticdocs/docs/configuration/plugins">Plugin</a>. You can create a simple plugin called SCRIPTS or PROCEDURES that only contains lib and procedures directories to store scripts. If COSMOS detects a plugin without defined cmd/tlm it will not spawn microservices for telemetry processing.</p>
|
112
112
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="organizing-your-scripts-into-a-plugin">Organizing Your Scripts into a Plugin<a href="#organizing-your-scripts-into-a-plugin" class="hash-link" aria-label="Direct link to Organizing Your Scripts into a Plugin" title="Direct link to Organizing Your Scripts into a Plugin"></a></h3>
|
113
113
|
<p>As your scripts become large with many methods, it makes sense to break them up into multiple files within a plugin. Here is a recommended organization for your plugin's scripts/procedures.</p>
|
114
|
-
<
|
115
|
-
| targets/TARGET_NAME/lib | Place script files containing reusable target specific methods here |
|
116
|
-
| targets/TARGET_NAME/procedures | Place simple procedures that are centered around one specific target here |</p>
|
114
|
+
<table><thead><tr><th>Folder</th><th>Description</th></tr></thead><tbody><tr><td>targets/TARGET_NAME/lib</td><td>Place script files containing reusable target specific methods here</td></tr><tr><td>targets/TARGET_NAME/procedures</td><td>Place simple procedures that are centered around one specific target here</td></tr></tbody></table>
|
117
115
|
<p>In your main procedure you will usually bring in the other files with instrumentation using load_utility.</p>
|
118
116
|
<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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Ruby:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">load_utility</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TARGET/lib/my_other_script.rb'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Python:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">load_utility</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'TARGET/procedures/my_other_script.py'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
119
117
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="organize-scripts-into-methods">Organize Scripts into Methods<a href="#organize-scripts-into-methods" class="hash-link" aria-label="Direct link to Organize Scripts into Methods" title="Direct link to Organize Scripts into Methods"></a></h3>
|
@@ -130,7 +128,7 @@
|
|
130
128
|
<p>Python:</p>
|
131
129
|
<div class="language-python codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-python codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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)">Gimbal</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 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">gimbal_steps </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)">0</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)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">move</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"> steps_to_move</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Move the gimbal</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">gimbal_steps </span><span class="token operator" style="color:rgb(127, 219, 202)">+=</span><span class="token plain"> steps_to_move</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)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">home_gimbal</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 punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Home the gimbal</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">gimbal_steps </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)">0</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)">def</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">perform_common_math</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">x</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> y</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"> x </span><span class="token operator" style="color:rgb(127, 219, 202)">+</span><span class="token plain"> y</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">gimbal </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> Gimbal</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">gimbal</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">home_gimbal</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">gimbal</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">move</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token number" style="color:rgb(247, 140, 108)">100</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">gimbal</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">move</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token number" style="color:rgb(247, 140, 108)">200</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">print</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">f"Moved gimbal </span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string-interpolation interpolation">gimbal</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token string-interpolation interpolation">gimbal_steps</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">"</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">result </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> perform_common_math</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">gimbal</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">gimbal_steps</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">10</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token keyword" style="color:rgb(127, 219, 202)">print</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">f"Math:</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token string-interpolation interpolation">result</span><span class="token string-interpolation interpolation punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token string-interpolation string" style="color:rgb(173, 219, 103)">"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
132
130
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="instrumented-vs-uninstrumented-lines-require-vs-load">Instrumented vs Uninstrumented Lines (require vs load)<a href="#instrumented-vs-uninstrumented-lines-require-vs-load" class="hash-link" aria-label="Direct link to Instrumented vs Uninstrumented Lines (require vs load)" title="Direct link to Instrumented vs Uninstrumented Lines (require vs load)"></a></h3>
|
133
|
-
<p>COSMOS scripts are normally “instrumented
|
131
|
+
<p>COSMOS scripts are normally “instrumented”. This means that each line has some extra code added behind the scenes that primarily highlights the current executing line and catches exceptions if things fail such as a wait_check. If your script needs to use code in other files, there are a few ways to bring in that code. Some techniques bring in instrumented code and others bring in uninstrumented code. There are reasons to use both.</p>
|
134
132
|
<p>load_utility (and the deprecated require_utility), bring in instrumented code from other files. When COSMOS runs the code in the other file, Script Runner will dive into the other file and show each line highlighted as it executes. This should be the default way to bring in other files, as it allows continuing if something fails, and provides better visibility to operators.</p>
|
135
133
|
<p>However, sometimes you don't want to display code executing from other files. Externally developed libraries generally do not like to be instrumented, and code that contains large loops or that just takes a long time to execute when highlighting lines, will be much faster if included in a method that does not instrument lines. Ruby provides two ways to bring in uninstrumented code. The first is the “load” keyword. Load will bring in the code from another file and will bring in any changes to the file if it is updated on the next call to load. “require” is like load but is optimized to only bring in the code from another file once. Therefore, if you use require and then change the file it requires, you must restart Script Runner to re-require the file and bring in the changes. In general, load is recommended over require for COSMOS scripting. One gotcha with load is that it requires the full filename including extension, while the require keyword does not.</p>
|
136
134
|
<p>In Python, libraries are included using the import syntax. Any code imported using import is not instrumented. Only the code imported using load_utility is instrumented.</p>
|
@@ -255,6 +253,6 @@
|
|
255
253
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="when-to-use-ruby-modules">When to use Ruby Modules<a href="#when-to-use-ruby-modules" class="hash-link" aria-label="Direct link to When to use Ruby Modules" title="Direct link to When to use Ruby Modules"></a></h3>
|
256
254
|
<p>Modules in Ruby have two purposes: namespacing and mixins. Namespacing allows having classes and methods with the same name, but with different meanings. For example, if they are namespaced, COSMOS can have a Packet class and another Ruby library can have a Packet class. This isn't typically useful for COSMOS scripting though.</p>
|
257
255
|
<p>Mixins allow adding common methods to classes without using inheritance. Mixins can be useful to add common functionality to some classes but not others, or to break up classes into multiple files.</p>
|
258
|
-
<div class="language-ruby codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-ruby codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token 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)">MyModule</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)">module_method</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)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">MyTest</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain"> OpenC3</span><span class="token double-colon punctuation" style="color:rgb(199, 146, 234)">::</span><span class="token plain">Group</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)">include</span><span class="token plain"> MyModule</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)">test_1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> module_method</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)">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"></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="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/script-writing.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_T23F"></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/guides/raspberrypi"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Raspberry Pi</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/guides/scripting-api"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Scripting API Guide</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#ruby-vs-python-in-cosmos" class="table-of-contents__link toc-highlight">Ruby vs Python in COSMOS</a></li></ul></li><li><a href="#scripting-philosophy" class="table-of-contents__link toc-highlight">Scripting Philosophy</a><ul><li><a href="#a-super-basic-script-example" class="table-of-contents__link toc-highlight">A Super Basic Script Example</a></li><li><a href="#kiss-keep-it-simple-stupid" class="table-of-contents__link toc-highlight">KISS (Keep It Simple Stupid)</a></li><li><a href="#keep-things-dry-dont-repeat-yourself" class="table-of-contents__link toc-highlight">Keep things DRY (Don't Repeat Yourself)</a></li><li><a href="#use-comments-appropriately" class="table-of-contents__link toc-highlight">Use Comments Appropriately</a></li><li><a href="#script-runner" class="table-of-contents__link toc-highlight">Script Runner</a></li><li><a href="#looping-vs-unrolled-loops" class="table-of-contents__link toc-highlight">Looping vs Unrolled Loops</a></li></ul></li><li><a href="#script-organization" class="table-of-contents__link toc-highlight">Script Organization</a><ul><li><a href="#organizing-your-scripts-into-a-plugin" class="table-of-contents__link toc-highlight">Organizing Your Scripts into a Plugin</a></li><li><a href="#organize-scripts-into-methods" class="table-of-contents__link toc-highlight">Organize Scripts into Methods</a></li><li><a href="#using-classes-vs-unscoped-methods" class="table-of-contents__link toc-highlight">Using Classes vs Unscoped Methods</a></li><li><a href="#instrumented-vs-uninstrumented-lines-require-vs-load" class="table-of-contents__link toc-highlight">Instrumented vs Uninstrumented Lines (require vs load)</a></li></ul></li><li><a href="#debugging-and-auditing" class="table-of-contents__link toc-highlight">Debugging and Auditing</a><ul><li><a href="#built-in-debugging-capabilities" class="table-of-contents__link toc-highlight">Built-In Debugging Capabilities</a></li><li><a href="#breakpoints" class="table-of-contents__link toc-highlight">Breakpoints</a></li><li><a href="#using-disconnect-mode" class="table-of-contents__link toc-highlight">Using Disconnect Mode</a></li><li><a href="#auditing-your-scripts" class="table-of-contents__link toc-highlight">Auditing your Scripts</a><ul><li><a href="#ruby-syntax-check" class="table-of-contents__link toc-highlight">Ruby Syntax Check</a></li></ul></li></ul></li><li><a href="#common-scenarios" class="table-of-contents__link toc-highlight">Common Scenarios</a><ul><li><a href="#user-input-best-practices" class="table-of-contents__link toc-highlight">User Input Best Practices</a></li><li><a href="#conditionally-require-manual-user-input-steps" class="table-of-contents__link toc-highlight">Conditionally Require Manual User Input Steps</a></li><li><a href="#outputing-extra-information-to-a-report" class="table-of-contents__link toc-highlight">Outputing Extra Information to a Report</a></li><li><a href="#getting-the-most-recent-value-of-a-telemetry-point-from-multiple-packets" class="table-of-contents__link toc-highlight">Getting the Most Recent Value of a Telemetry Point from Multiple Packets</a></li><li><a href="#checking-every-single-sample-of-a-telemetry-point" class="table-of-contents__link toc-highlight">Checking Every Single Sample of a Telemetry Point</a></li><li><a href="#using-variables-in-mnemonics" class="table-of-contents__link toc-highlight">Using Variables in Mnemonics</a></li><li><a href="#using-custom-wait_check_expression" class="table-of-contents__link toc-highlight">Using Custom wait_check_expression</a></li><li><a href="#cosmos-scripting-differences-from-regular-ruby-scripting" class="table-of-contents__link toc-highlight">COSMOS Scripting Differences from Regular Ruby Scripting</a><ul><li><a href="#do-not-use-single-line-if-statements" class="table-of-contents__link toc-highlight">Do not use single line if statements</a></li></ul></li></ul></li><li><a href="#when-things-go-wrong" class="table-of-contents__link toc-highlight">When Things Go Wrong</a><ul><li><a href="#common-reasons-checks-fail" class="table-of-contents__link toc-highlight">Common Reasons Checks Fail</a></li><li><a href="#how-to-recover-from-anomalies" class="table-of-contents__link toc-highlight">How to Recover from Anomalies</a></li></ul></li><li><a href="#advanced-topics" class="table-of-contents__link toc-highlight">Advanced Topics</a><ul><li><a href="#advanced-script-configuration-with-csv-or-excel" class="table-of-contents__link toc-highlight">Advanced Script Configuration with CSV or Excel</a></li><li><a href="#when-to-use-ruby-modules" class="table-of-contents__link toc-highlight">When to use Ruby Modules</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
|
256
|
+
<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 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)">MyModule</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)">module_method</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)">class</span><span class="token plain"> </span><span class="token class-name" style="color:rgb(255, 203, 139)">MyTest</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain"> OpenC3</span><span class="token double-colon punctuation" style="color:rgb(199, 146, 234)">::</span><span class="token plain">Group</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)">include</span><span class="token plain"> MyModule</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)">test_1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> module_method</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)">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"></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="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/script-writing.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_T23F"></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/guides/raspberrypi"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Raspberry Pi</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/guides/scripting-api"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Scripting API Guide</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#ruby-vs-python-in-cosmos" class="table-of-contents__link toc-highlight">Ruby vs Python in COSMOS</a></li></ul></li><li><a href="#scripting-philosophy" class="table-of-contents__link toc-highlight">Scripting Philosophy</a><ul><li><a href="#a-super-basic-script-example" class="table-of-contents__link toc-highlight">A Super Basic Script Example</a></li><li><a href="#kiss-keep-it-simple-stupid" class="table-of-contents__link toc-highlight">KISS (Keep It Simple Stupid)</a></li><li><a href="#keep-things-dry-dont-repeat-yourself" class="table-of-contents__link toc-highlight">Keep things DRY (Don't Repeat Yourself)</a></li><li><a href="#use-comments-appropriately" class="table-of-contents__link toc-highlight">Use Comments Appropriately</a></li><li><a href="#script-runner" class="table-of-contents__link toc-highlight">Script Runner</a></li><li><a href="#looping-vs-unrolled-loops" class="table-of-contents__link toc-highlight">Looping vs Unrolled Loops</a></li></ul></li><li><a href="#script-organization" class="table-of-contents__link toc-highlight">Script Organization</a><ul><li><a href="#organizing-your-scripts-into-a-plugin" class="table-of-contents__link toc-highlight">Organizing Your Scripts into a Plugin</a></li><li><a href="#organize-scripts-into-methods" class="table-of-contents__link toc-highlight">Organize Scripts into Methods</a></li><li><a href="#using-classes-vs-unscoped-methods" class="table-of-contents__link toc-highlight">Using Classes vs Unscoped Methods</a></li><li><a href="#instrumented-vs-uninstrumented-lines-require-vs-load" class="table-of-contents__link toc-highlight">Instrumented vs Uninstrumented Lines (require vs load)</a></li></ul></li><li><a href="#debugging-and-auditing" class="table-of-contents__link toc-highlight">Debugging and Auditing</a><ul><li><a href="#built-in-debugging-capabilities" class="table-of-contents__link toc-highlight">Built-In Debugging Capabilities</a></li><li><a href="#breakpoints" class="table-of-contents__link toc-highlight">Breakpoints</a></li><li><a href="#using-disconnect-mode" class="table-of-contents__link toc-highlight">Using Disconnect Mode</a></li><li><a href="#auditing-your-scripts" class="table-of-contents__link toc-highlight">Auditing your Scripts</a><ul><li><a href="#ruby-syntax-check" class="table-of-contents__link toc-highlight">Ruby Syntax Check</a></li></ul></li></ul></li><li><a href="#common-scenarios" class="table-of-contents__link toc-highlight">Common Scenarios</a><ul><li><a href="#user-input-best-practices" class="table-of-contents__link toc-highlight">User Input Best Practices</a></li><li><a href="#conditionally-require-manual-user-input-steps" class="table-of-contents__link toc-highlight">Conditionally Require Manual User Input Steps</a></li><li><a href="#outputing-extra-information-to-a-report" class="table-of-contents__link toc-highlight">Outputing Extra Information to a Report</a></li><li><a href="#getting-the-most-recent-value-of-a-telemetry-point-from-multiple-packets" class="table-of-contents__link toc-highlight">Getting the Most Recent Value of a Telemetry Point from Multiple Packets</a></li><li><a href="#checking-every-single-sample-of-a-telemetry-point" class="table-of-contents__link toc-highlight">Checking Every Single Sample of a Telemetry Point</a></li><li><a href="#using-variables-in-mnemonics" class="table-of-contents__link toc-highlight">Using Variables in Mnemonics</a></li><li><a href="#using-custom-wait_check_expression" class="table-of-contents__link toc-highlight">Using Custom wait_check_expression</a></li><li><a href="#cosmos-scripting-differences-from-regular-ruby-scripting" class="table-of-contents__link toc-highlight">COSMOS Scripting Differences from Regular Ruby Scripting</a><ul><li><a href="#do-not-use-single-line-if-statements" class="table-of-contents__link toc-highlight">Do not use single line if statements</a></li></ul></li></ul></li><li><a href="#when-things-go-wrong" class="table-of-contents__link toc-highlight">When Things Go Wrong</a><ul><li><a href="#common-reasons-checks-fail" class="table-of-contents__link toc-highlight">Common Reasons Checks Fail</a></li><li><a href="#how-to-recover-from-anomalies" class="table-of-contents__link toc-highlight">How to Recover from Anomalies</a></li></ul></li><li><a href="#advanced-topics" class="table-of-contents__link toc-highlight">Advanced Topics</a><ul><li><a href="#advanced-script-configuration-with-csv-or-excel" class="table-of-contents__link toc-highlight">Advanced Script Configuration with CSV or Excel</a></li><li><a href="#when-to-use-ruby-modules" class="table-of-contents__link toc-highlight">When to use Ruby Modules</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
259
257
|
</body>
|
260
258
|
</html>
|
@@ -2,10 +2,10 @@
|
|
2
2
|
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/scripting-api" data-has-hydrated="false">
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
|
-
<meta name="generator" content="Docusaurus v3.
|
6
|
-
<title data-rh="true">Scripting API Guide | 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/guides/scripting-api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Scripting API Guide | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket."><meta data-rh="true" property="og:description" content="This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
5
|
+
<meta name="generator" content="Docusaurus v3.1.0">
|
6
|
+
<title data-rh="true">Scripting API Guide | 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/guides/scripting-api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Scripting API Guide | OpenC3 Docs"><meta data-rh="true" name="description" content="This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket."><meta data-rh="true" property="og:description" content="This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/guides/scripting-api" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.dd31dbff.css">
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.023a2c4f.js" defer="defer"></script>
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.f5f96e22.js" defer="defer"></script>
|
9
9
|
</head>
|
10
10
|
<body class="navigation-with-keyboard">
|
11
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 localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)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" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" 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" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" 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" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" 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" aria-expanded="true" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Collapse sidebar category 'Guides'" 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/guides/bridges">Bridges</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/guides/cfs">COSMOS and NASA cFS</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/guides/custom-widgets">Custom Widgets</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/guides/little-endian-bitfields">Little Endian Bitfields</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/guides/local-mode">Local Mode</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/guides/logging">Logging</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/guides/monitoring">Monitoring</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/guides/performance">Performance</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/guides/raspberrypi">Raspberry Pi</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/guides/script-writing">Script Writing Guide</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/guides/scripting-api">Scripting API Guide</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" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" 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" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" 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/guides"><span itemprop="name">Guides</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">Scripting API Guide</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>Scripting API Guide</h1></header><p>This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.</p>
|
@@ -929,7 +929,7 @@ Consider breaking code like this into a seperate file and using either require/l
|
|
929
929
|
<p>Ruby Syntax / Example:</p>
|
930
930
|
<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 plain">disable_instrumentation </span><span class="token keyword" style="color:rgb(127, 219, 202)">do</span><span class="token plain"></span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1000.</span><span class="token plain">times </span><span class="token keyword" style="color:rgb(127, 219, 202)">do</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"># Don't want this to have to highlight 1000 times</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"></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>
|
931
931
|
<p>Python Syntax / Example:</p>
|
932
|
-
<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 keyword" style="color:rgb(127, 219, 202)">with</span><span class="token plain"> disable_instrumentation</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)">for</span><span class="token plain"> x </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">range</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token number" style="color:rgb(247, 140, 108)">
|
932
|
+
<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 keyword" style="color:rgb(127, 219, 202)">with</span><span class="token plain"> disable_instrumentation</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"></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)">for</span><span class="token plain"> x </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> </span><span class="token builtin" style="color:rgb(130, 170, 255)">range</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token number" style="color:rgb(247, 140, 108)">1000</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 comment" style="color:rgb(99, 119, 119);font-style:italic"># Don't want this to have to highlight 1000 times</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>
|
933
933
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="script-runner-suites">Script Runner Suites<a href="#script-runner-suites" class="hash-link" aria-label="Direct link to Script Runner Suites" title="Direct link to Script Runner Suites"></a></h2>
|
934
934
|
<p>Creating Script Runner suites utilizes APIs to add groups to the defined suites. For more information please see <a href="/tools/staticdocs/docs/tools/script-runner#running-script-suites">running script suites</a>.</p>
|
935
935
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="add_group-add_group_setup-add_group_teardown-add_script">add_group, add_group_setup, add_group_teardown, add_script<a href="#add_group-add_group_setup-add_group_teardown-add_script" class="hash-link" aria-label="Direct link to add_group, add_group_setup, add_group_teardown, add_script" title="Direct link to add_group, add_group_setup, add_group_teardown, add_script"></a></h3>
|
@@ -1068,6 +1068,6 @@ Consider breaking code like this into a seperate file and using either require/l
|
|
1068
1068
|
<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 plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">Tool Name</span><span class="token operator" style="color:rgb(127, 219, 202)">></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">Configuration Name</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> local_mode</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
1069
1069
|
<table><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td>Tool Name</td><td>Name of the tool</td></tr><tr><td>Configuration Name</td><td>Name of the configuration</td></tr><tr><td>local_mode</td><td>Whether to delete the configuration in local mode</td></tr></tbody></table>
|
1070
1070
|
<p>Ruby / Python Example:</p>
|
1071
|
-
<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 plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'telemetry_grapher'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'adcs'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/scripting-api.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></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/guides/script-writing"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#programming-languages" class="table-of-contents__link toc-highlight">Programming Languages</a></li><li><a href="#using-script-runner" class="table-of-contents__link toc-highlight">Using Script Runner</a></li><li><a href="#telemetry-types" class="table-of-contents__link toc-highlight">Telemetry Types</a></li></ul></li><li><a href="#script-runner-api" class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href="#migration-from-cosmos-v4" class="table-of-contents__link toc-highlight">Migration from COSMOS v4</a></li></ul></li><li><a href="#retrieving-user-input" class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href="#ask" class="table-of-contents__link toc-highlight">ask</a></li><li><a href="#ask_string" class="table-of-contents__link toc-highlight">ask_string</a></li><li><a href="#message_box" class="table-of-contents__link toc-highlight">message_box</a></li><li><a href="#vertical_message_box" class="table-of-contents__link toc-highlight">vertical_message_box</a></li><li><a href="#combo_box" class="table-of-contents__link toc-highlight">combo_box</a></li><li><a href="#get_target_file" class="table-of-contents__link toc-highlight">get_target_file</a></li><li><a href="#put_target_file" class="table-of-contents__link toc-highlight">put_target_file</a></li><li><a href="#delete_target_file" class="table-of-contents__link toc-highlight">delete_target_file</a></li><li><a href="#open_file_dialog" class="table-of-contents__link toc-highlight">open_file_dialog</a></li><li><a href="#open_files_dialog" class="table-of-contents__link toc-highlight">open_files_dialog</a></li></ul></li><li><a href="#providing-information-to-the-user" class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href="#prompt" class="table-of-contents__link toc-highlight">prompt</a></li></ul></li><li><a href="#commands" class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href="#cmd" class="table-of-contents__link toc-highlight">cmd</a></li><li><a href="#cmd_no_range_check" class="table-of-contents__link toc-highlight">cmd_no_range_check</a></li><li><a href="#cmd_no_hazardous_check" class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a></li><li><a href="#cmd_no_checks" class="table-of-contents__link toc-highlight">cmd_no_checks</a></li><li><a href="#cmd_raw" class="table-of-contents__link toc-highlight">cmd_raw</a></li><li><a href="#cmd_raw_no_range_check" class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a></li><li><a href="#cmd_raw_no_hazardous_check" class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a></li><li><a href="#cmd_raw_no_checks" class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a></li><li><a href="#build_cmd-since-5130-since-580-as-build_command" class="table-of-contents__link toc-highlight">build_cmd (since 5.13.0, since 5.8.0 as build_command)</a></li><li><a href="#send_raw" class="table-of-contents__link toc-highlight">send_raw</a></li><li><a href="#get_all_cmds-since-5130-since-500-as-get_all_commands" class="table-of-contents__link toc-highlight">get_all_cmds (since 5.13.0, since 5.0.0 as get_all_commands)</a></li><li><a href="#get_all_cmd_names-since-5130-since-506-as-get_all_command_names" class="table-of-contents__link toc-highlight">get_all_cmd_names (since 5.13.0, since 5.0.6 as get_all_command_names)</a></li><li><a href="#get_cmd-since-5130-since-500-as-get_command" class="table-of-contents__link toc-highlight">get_cmd (since 5.13.0, since 5.0.0 as get_command)</a></li><li><a href="#get_param-since-5130-since-500-as-get_parameter" class="table-of-contents__link toc-highlight">get_param (since 5.13.0, since 5.0.0 as get_parameter)</a></li><li><a href="#get_cmd_buffer" class="table-of-contents__link toc-highlight">get_cmd_buffer</a></li><li><a href="#get_cmd_hazardous" class="table-of-contents__link toc-highlight">get_cmd_hazardous</a></li><li><a href="#get_cmd_value" class="table-of-contents__link toc-highlight">get_cmd_value</a></li><li><a href="#get_cmd_time" class="table-of-contents__link toc-highlight">get_cmd_time</a></li><li><a href="#get_cmd_cnt" class="table-of-contents__link toc-highlight">get_cmd_cnt</a></li></ul></li><li><a href="#handling-telemetry" class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href="#check-check_raw-check_formatted-check_with_units" class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a></li><li><a href="#check_tolerance" class="table-of-contents__link toc-highlight">check_tolerance</a></li><li><a href="#check_expression" class="table-of-contents__link toc-highlight">check_expression</a></li><li><a href="#check_exception" class="table-of-contents__link toc-highlight">check_exception</a></li><li><a href="#tlm-tlm_raw-tlm_formatted-tlm_with_units" class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a></li><li><a href="#get_tlm_buffer" class="table-of-contents__link toc-highlight">get_tlm_buffer</a></li><li><a href="#get_tlm_packet" class="table-of-contents__link toc-highlight">get_tlm_packet</a></li><li><a href="#get_tlm_values-modified-in-500" class="table-of-contents__link toc-highlight">get_tlm_values (modified in 5.0.0)</a></li><li><a href="#get_all_tlm-since-5130-since-500-as-get_all_telemetry" class="table-of-contents__link toc-highlight">get_all_tlm (since 5.13.0, since 5.0.0 as get_all_telemetry)</a></li><li><a href="#get_all_tlm_names-since-5130-since-506-as-get_all_telemetry_names" class="table-of-contents__link toc-highlight">get_all_tlm_names (since 5.13.0, since 5.0.6 as get_all_telemetry_names)</a></li><li><a href="#get_tlm-since-5130-since-500-as-get_telemetry" class="table-of-contents__link toc-highlight">get_tlm (since 5.13.0, since 5.0.0 as get_telemetry)</a></li><li><a href="#get_item-since-500" class="table-of-contents__link toc-highlight">get_item (since 5.0.0)</a></li><li><a href="#get_tlm_cnt" class="table-of-contents__link toc-highlight">get_tlm_cnt</a></li><li><a href="#set_tlm" class="table-of-contents__link toc-highlight">set_tlm</a></li><li><a href="#inject_tlm" class="table-of-contents__link toc-highlight">inject_tlm</a></li><li><a href="#override_tlm" class="table-of-contents__link toc-highlight">override_tlm</a></li><li><a href="#normalize_tlm" class="table-of-contents__link toc-highlight">normalize_tlm</a></li><li><a href="#get_overrides" class="table-of-contents__link toc-highlight">get_overrides</a></li></ul></li><li><a href="#packet-data-subscriptions" class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href="#subscribe_packets-since-503" class="table-of-contents__link toc-highlight">subscribe_packets (since 5.0.3)</a></li><li><a href="#get_packets-since-503" class="table-of-contents__link toc-highlight">get_packets (since 5.0.3)</a></li><li><a href="#get_tlm_cnt-1" class="table-of-contents__link toc-highlight">get_tlm_cnt</a></li><li><a href="#get_tlm_cnts" class="table-of-contents__link toc-highlight">get_tlm_cnts</a></li><li><a href="#get_packet_derived_items" class="table-of-contents__link toc-highlight">get_packet_derived_items</a></li></ul></li><li><a href="#delays" class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href="#wait" class="table-of-contents__link toc-highlight">wait</a></li><li><a href="#wait_tolerance" class="table-of-contents__link toc-highlight">wait_tolerance</a></li><li><a href="#wait_expression" class="table-of-contents__link toc-highlight">wait_expression</a></li><li><a href="#wait_packet" class="table-of-contents__link toc-highlight">wait_packet</a></li><li><a href="#wait_check" class="table-of-contents__link toc-highlight">wait_check</a></li><li><a href="#wait_check_tolerance" class="table-of-contents__link toc-highlight">wait_check_tolerance</a></li><li><a href="#wait_check_expression" class="table-of-contents__link toc-highlight">wait_check_expression</a></li><li><a href="#wait_check_packet" class="table-of-contents__link toc-highlight">wait_check_packet</a></li></ul></li><li><a href="#limits" class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href="#limits_enabled-limits_enabled" class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a></li><li><a href="#enable_limits" class="table-of-contents__link toc-highlight">enable_limits</a></li><li><a href="#disable_limits" class="table-of-contents__link toc-highlight">disable_limits</a></li><li><a href="#enable_limits_group" class="table-of-contents__link toc-highlight">enable_limits_group</a></li><li><a href="#disable_limits_group" class="table-of-contents__link toc-highlight">disable_limits_group</a></li><li><a href="#get_limits_groups" class="table-of-contents__link toc-highlight">get_limits_groups</a></li><li><a href="#set_limits_set" class="table-of-contents__link toc-highlight">set_limits_set</a></li><li><a href="#get_limits_set" class="table-of-contents__link toc-highlight">get_limits_set</a></li><li><a href="#get_limits_sets" class="table-of-contents__link toc-highlight">get_limits_sets</a></li><li><a href="#get_limits" class="table-of-contents__link toc-highlight">get_limits</a></li><li><a href="#set_limits" class="table-of-contents__link toc-highlight">set_limits</a></li><li><a href="#get_out_of_limits" class="table-of-contents__link toc-highlight">get_out_of_limits</a></li><li><a href="#get_overall_limits_state" class="table-of-contents__link toc-highlight">get_overall_limits_state</a></li><li><a href="#get_limits_events" class="table-of-contents__link toc-highlight">get_limits_events</a></li></ul></li><li><a href="#targets" class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href="#get_target_names" class="table-of-contents__link toc-highlight">get_target_names</a></li><li><a href="#get_target" class="table-of-contents__link toc-highlight">get_target</a></li><li><a href="#get_target_interfaces" class="table-of-contents__link toc-highlight">get_target_interfaces</a></li></ul></li><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href="#get_interface-since-500" class="table-of-contents__link toc-highlight">get_interface (since 5.0.0)</a></li><li><a href="#get_interface_names" class="table-of-contents__link toc-highlight">get_interface_names</a></li><li><a href="#connect_interface" class="table-of-contents__link toc-highlight">connect_interface</a></li><li><a href="#disconnect_interface" class="table-of-contents__link toc-highlight">disconnect_interface</a></li><li><a href="#start_raw_logging_interface" class="table-of-contents__link toc-highlight">start_raw_logging_interface</a></li><li><a href="#stop_raw_logging_interface" class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a></li><li><a href="#get_all_interface_info" class="table-of-contents__link toc-highlight">get_all_interface_info</a></li><li><a href="#map_target_to_interface" class="table-of-contents__link toc-highlight">map_target_to_interface</a></li><li><a href="#interface_cmd" class="table-of-contents__link toc-highlight">interface_cmd</a></li><li><a href="#interface_protocol_cmd" class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></li></ul></li><li><a href="#routers" class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href="#connect_router" class="table-of-contents__link toc-highlight">connect_router</a></li><li><a href="#disconnect_router" class="table-of-contents__link toc-highlight">disconnect_router</a></li><li><a href="#get_router_names" class="table-of-contents__link toc-highlight">get_router_names</a></li><li><a href="#get_router-since-500" class="table-of-contents__link toc-highlight">get_router (since 5.0.0)</a></li><li><a href="#get_all_router_info" class="table-of-contents__link toc-highlight">get_all_router_info</a></li><li><a href="#start_raw_logging_router" class="table-of-contents__link toc-highlight">start_raw_logging_router</a></li><li><a href="#stop_raw_logging_router" class="table-of-contents__link toc-highlight">stop_raw_logging_router</a></li><li><a href="#router_cmd" class="table-of-contents__link toc-highlight">router_cmd</a></li><li><a href="#router_protocol_cmd" class="table-of-contents__link toc-highlight">router_protocol_cmd</a></li></ul></li><li><a href="#stashing-data" class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href="#stash_set" class="table-of-contents__link toc-highlight">stash_set</a></li><li><a href="#stash_get" class="table-of-contents__link toc-highlight">stash_get</a></li><li><a href="#stash_all" class="table-of-contents__link toc-highlight">stash_all</a></li><li><a href="#stash_keys" class="table-of-contents__link toc-highlight">stash_keys</a></li><li><a href="#stash_delete" class="table-of-contents__link toc-highlight">stash_delete</a></li></ul></li><li><a href="#executing-other-procedures" class="table-of-contents__link toc-highlight">Executing Other Procedures</a><ul><li><a href="#start" class="table-of-contents__link toc-highlight">start</a></li><li><a href="#load_utility" class="table-of-contents__link toc-highlight">load_utility</a></li></ul></li><li><a href="#opening-closing--creating-telemetry-screens" class="table-of-contents__link toc-highlight">Opening, Closing & Creating Telemetry Screens</a><ul><li><a href="#display_screen" class="table-of-contents__link toc-highlight">display_screen</a></li><li><a href="#clear_screen" class="table-of-contents__link toc-highlight">clear_screen</a></li><li><a href="#clear_all_screens" class="table-of-contents__link toc-highlight">clear_all_screens</a></li><li><a href="#delete_screen" class="table-of-contents__link toc-highlight">delete_screen</a></li><li><a href="#get_screen_list" class="table-of-contents__link toc-highlight">get_screen_list</a></li><li><a href="#get_screen_definition" class="table-of-contents__link toc-highlight">get_screen_definition</a></li><li><a href="#create_screen" class="table-of-contents__link toc-highlight">create_screen</a></li><li><a href="#local_screen" class="table-of-contents__link toc-highlight">local_screen</a></li></ul></li><li><a href="#script-runner-settings" class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href="#set_line_delay" class="table-of-contents__link toc-highlight">set_line_delay</a></li><li><a href="#get_line_delay" class="table-of-contents__link toc-highlight">get_line_delay</a></li><li><a href="#set_max_output" class="table-of-contents__link toc-highlight">set_max_output</a></li><li><a href="#get_max_output" class="table-of-contents__link toc-highlight">get_max_output</a></li><li><a href="#disable_instrumentation" class="table-of-contents__link toc-highlight">disable_instrumentation</a></li></ul></li><li><a href="#script-runner-suites" class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href="#add_group-add_group_setup-add_group_teardown-add_script" class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></li></ul></li><li><a href="#script-runner-debugging" class="table-of-contents__link toc-highlight">Script Runner Debugging</a><ul><li><a href="#step_mode" class="table-of-contents__link toc-highlight">step_mode</a></li><li><a href="#run_mode" class="table-of-contents__link toc-highlight">run_mode</a></li><li><a href="#disconnect_script" class="table-of-contents__link toc-highlight">disconnect_script</a></li></ul></li><li><a href="#metadata" class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href="#metadata_all" class="table-of-contents__link toc-highlight">metadata_all</a></li><li><a href="#metadata_get" class="table-of-contents__link toc-highlight">metadata_get</a></li><li><a href="#metadata_set" class="table-of-contents__link toc-highlight">metadata_set</a></li><li><a href="#metadata_update" class="table-of-contents__link toc-highlight">metadata_update</a></li><li><a href="#metadata_input" class="table-of-contents__link toc-highlight">metadata_input</a></li></ul></li><li><a href="#settings" class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href="#list_settings" class="table-of-contents__link toc-highlight">list_settings</a></li><li><a href="#get_all_settings" class="table-of-contents__link toc-highlight">get_all_settings</a></li><li><a href="#get_setting-get_settings" class="table-of-contents__link toc-highlight">get_setting, get_settings</a></li><li><a href="#set_setting" class="table-of-contents__link toc-highlight">set_setting</a></li></ul></li><li><a href="#configuration" class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href="#config_tool_names" class="table-of-contents__link toc-highlight">config_tool_names</a></li><li><a href="#list_configs" class="table-of-contents__link toc-highlight">list_configs</a></li><li><a href="#load_config" class="table-of-contents__link toc-highlight">load_config</a></li><li><a href="#save_config" class="table-of-contents__link toc-highlight">save_config</a></li><li><a href="#delete_config" class="table-of-contents__link toc-highlight">delete_config</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 OpenC3, Inc.</div></div></div></footer></div>
|
1071
|
+
<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 plain">delete_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'telemetry_grapher'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string-literal string" style="color:rgb(173, 219, 103)">'adcs'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/scripting-api.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></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/guides/script-writing"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Script Writing Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#programming-languages" class="table-of-contents__link toc-highlight">Programming Languages</a></li><li><a href="#using-script-runner" class="table-of-contents__link toc-highlight">Using Script Runner</a></li><li><a href="#telemetry-types" class="table-of-contents__link toc-highlight">Telemetry Types</a></li></ul></li><li><a href="#script-runner-api" class="table-of-contents__link toc-highlight">Script Runner API</a><ul><li><a href="#migration-from-cosmos-v4" class="table-of-contents__link toc-highlight">Migration from COSMOS v4</a></li></ul></li><li><a href="#retrieving-user-input" class="table-of-contents__link toc-highlight">Retrieving User Input</a><ul><li><a href="#ask" class="table-of-contents__link toc-highlight">ask</a></li><li><a href="#ask_string" class="table-of-contents__link toc-highlight">ask_string</a></li><li><a href="#message_box" class="table-of-contents__link toc-highlight">message_box</a></li><li><a href="#vertical_message_box" class="table-of-contents__link toc-highlight">vertical_message_box</a></li><li><a href="#combo_box" class="table-of-contents__link toc-highlight">combo_box</a></li><li><a href="#get_target_file" class="table-of-contents__link toc-highlight">get_target_file</a></li><li><a href="#put_target_file" class="table-of-contents__link toc-highlight">put_target_file</a></li><li><a href="#delete_target_file" class="table-of-contents__link toc-highlight">delete_target_file</a></li><li><a href="#open_file_dialog" class="table-of-contents__link toc-highlight">open_file_dialog</a></li><li><a href="#open_files_dialog" class="table-of-contents__link toc-highlight">open_files_dialog</a></li></ul></li><li><a href="#providing-information-to-the-user" class="table-of-contents__link toc-highlight">Providing information to the user</a><ul><li><a href="#prompt" class="table-of-contents__link toc-highlight">prompt</a></li></ul></li><li><a href="#commands" class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href="#cmd" class="table-of-contents__link toc-highlight">cmd</a></li><li><a href="#cmd_no_range_check" class="table-of-contents__link toc-highlight">cmd_no_range_check</a></li><li><a href="#cmd_no_hazardous_check" class="table-of-contents__link toc-highlight">cmd_no_hazardous_check</a></li><li><a href="#cmd_no_checks" class="table-of-contents__link toc-highlight">cmd_no_checks</a></li><li><a href="#cmd_raw" class="table-of-contents__link toc-highlight">cmd_raw</a></li><li><a href="#cmd_raw_no_range_check" class="table-of-contents__link toc-highlight">cmd_raw_no_range_check</a></li><li><a href="#cmd_raw_no_hazardous_check" class="table-of-contents__link toc-highlight">cmd_raw_no_hazardous_check</a></li><li><a href="#cmd_raw_no_checks" class="table-of-contents__link toc-highlight">cmd_raw_no_checks</a></li><li><a href="#build_cmd-since-5130-since-580-as-build_command" class="table-of-contents__link toc-highlight">build_cmd (since 5.13.0, since 5.8.0 as build_command)</a></li><li><a href="#send_raw" class="table-of-contents__link toc-highlight">send_raw</a></li><li><a href="#get_all_cmds-since-5130-since-500-as-get_all_commands" class="table-of-contents__link toc-highlight">get_all_cmds (since 5.13.0, since 5.0.0 as get_all_commands)</a></li><li><a href="#get_all_cmd_names-since-5130-since-506-as-get_all_command_names" class="table-of-contents__link toc-highlight">get_all_cmd_names (since 5.13.0, since 5.0.6 as get_all_command_names)</a></li><li><a href="#get_cmd-since-5130-since-500-as-get_command" class="table-of-contents__link toc-highlight">get_cmd (since 5.13.0, since 5.0.0 as get_command)</a></li><li><a href="#get_param-since-5130-since-500-as-get_parameter" class="table-of-contents__link toc-highlight">get_param (since 5.13.0, since 5.0.0 as get_parameter)</a></li><li><a href="#get_cmd_buffer" class="table-of-contents__link toc-highlight">get_cmd_buffer</a></li><li><a href="#get_cmd_hazardous" class="table-of-contents__link toc-highlight">get_cmd_hazardous</a></li><li><a href="#get_cmd_value" class="table-of-contents__link toc-highlight">get_cmd_value</a></li><li><a href="#get_cmd_time" class="table-of-contents__link toc-highlight">get_cmd_time</a></li><li><a href="#get_cmd_cnt" class="table-of-contents__link toc-highlight">get_cmd_cnt</a></li></ul></li><li><a href="#handling-telemetry" class="table-of-contents__link toc-highlight">Handling Telemetry</a><ul><li><a href="#check-check_raw-check_formatted-check_with_units" class="table-of-contents__link toc-highlight">check, check_raw, check_formatted, check_with_units</a></li><li><a href="#check_tolerance" class="table-of-contents__link toc-highlight">check_tolerance</a></li><li><a href="#check_expression" class="table-of-contents__link toc-highlight">check_expression</a></li><li><a href="#check_exception" class="table-of-contents__link toc-highlight">check_exception</a></li><li><a href="#tlm-tlm_raw-tlm_formatted-tlm_with_units" class="table-of-contents__link toc-highlight">tlm, tlm_raw, tlm_formatted, tlm_with_units</a></li><li><a href="#get_tlm_buffer" class="table-of-contents__link toc-highlight">get_tlm_buffer</a></li><li><a href="#get_tlm_packet" class="table-of-contents__link toc-highlight">get_tlm_packet</a></li><li><a href="#get_tlm_values-modified-in-500" class="table-of-contents__link toc-highlight">get_tlm_values (modified in 5.0.0)</a></li><li><a href="#get_all_tlm-since-5130-since-500-as-get_all_telemetry" class="table-of-contents__link toc-highlight">get_all_tlm (since 5.13.0, since 5.0.0 as get_all_telemetry)</a></li><li><a href="#get_all_tlm_names-since-5130-since-506-as-get_all_telemetry_names" class="table-of-contents__link toc-highlight">get_all_tlm_names (since 5.13.0, since 5.0.6 as get_all_telemetry_names)</a></li><li><a href="#get_tlm-since-5130-since-500-as-get_telemetry" class="table-of-contents__link toc-highlight">get_tlm (since 5.13.0, since 5.0.0 as get_telemetry)</a></li><li><a href="#get_item-since-500" class="table-of-contents__link toc-highlight">get_item (since 5.0.0)</a></li><li><a href="#get_tlm_cnt" class="table-of-contents__link toc-highlight">get_tlm_cnt</a></li><li><a href="#set_tlm" class="table-of-contents__link toc-highlight">set_tlm</a></li><li><a href="#inject_tlm" class="table-of-contents__link toc-highlight">inject_tlm</a></li><li><a href="#override_tlm" class="table-of-contents__link toc-highlight">override_tlm</a></li><li><a href="#normalize_tlm" class="table-of-contents__link toc-highlight">normalize_tlm</a></li><li><a href="#get_overrides" class="table-of-contents__link toc-highlight">get_overrides</a></li></ul></li><li><a href="#packet-data-subscriptions" class="table-of-contents__link toc-highlight">Packet Data Subscriptions</a><ul><li><a href="#subscribe_packets-since-503" class="table-of-contents__link toc-highlight">subscribe_packets (since 5.0.3)</a></li><li><a href="#get_packets-since-503" class="table-of-contents__link toc-highlight">get_packets (since 5.0.3)</a></li><li><a href="#get_tlm_cnt-1" class="table-of-contents__link toc-highlight">get_tlm_cnt</a></li><li><a href="#get_tlm_cnts" class="table-of-contents__link toc-highlight">get_tlm_cnts</a></li><li><a href="#get_packet_derived_items" class="table-of-contents__link toc-highlight">get_packet_derived_items</a></li></ul></li><li><a href="#delays" class="table-of-contents__link toc-highlight">Delays</a><ul><li><a href="#wait" class="table-of-contents__link toc-highlight">wait</a></li><li><a href="#wait_tolerance" class="table-of-contents__link toc-highlight">wait_tolerance</a></li><li><a href="#wait_expression" class="table-of-contents__link toc-highlight">wait_expression</a></li><li><a href="#wait_packet" class="table-of-contents__link toc-highlight">wait_packet</a></li><li><a href="#wait_check" class="table-of-contents__link toc-highlight">wait_check</a></li><li><a href="#wait_check_tolerance" class="table-of-contents__link toc-highlight">wait_check_tolerance</a></li><li><a href="#wait_check_expression" class="table-of-contents__link toc-highlight">wait_check_expression</a></li><li><a href="#wait_check_packet" class="table-of-contents__link toc-highlight">wait_check_packet</a></li></ul></li><li><a href="#limits" class="table-of-contents__link toc-highlight">Limits</a><ul><li><a href="#limits_enabled-limits_enabled" class="table-of-contents__link toc-highlight">limits_enabled?, limits_enabled</a></li><li><a href="#enable_limits" class="table-of-contents__link toc-highlight">enable_limits</a></li><li><a href="#disable_limits" class="table-of-contents__link toc-highlight">disable_limits</a></li><li><a href="#enable_limits_group" class="table-of-contents__link toc-highlight">enable_limits_group</a></li><li><a href="#disable_limits_group" class="table-of-contents__link toc-highlight">disable_limits_group</a></li><li><a href="#get_limits_groups" class="table-of-contents__link toc-highlight">get_limits_groups</a></li><li><a href="#set_limits_set" class="table-of-contents__link toc-highlight">set_limits_set</a></li><li><a href="#get_limits_set" class="table-of-contents__link toc-highlight">get_limits_set</a></li><li><a href="#get_limits_sets" class="table-of-contents__link toc-highlight">get_limits_sets</a></li><li><a href="#get_limits" class="table-of-contents__link toc-highlight">get_limits</a></li><li><a href="#set_limits" class="table-of-contents__link toc-highlight">set_limits</a></li><li><a href="#get_out_of_limits" class="table-of-contents__link toc-highlight">get_out_of_limits</a></li><li><a href="#get_overall_limits_state" class="table-of-contents__link toc-highlight">get_overall_limits_state</a></li><li><a href="#get_limits_events" class="table-of-contents__link toc-highlight">get_limits_events</a></li></ul></li><li><a href="#targets" class="table-of-contents__link toc-highlight">Targets</a><ul><li><a href="#get_target_names" class="table-of-contents__link toc-highlight">get_target_names</a></li><li><a href="#get_target" class="table-of-contents__link toc-highlight">get_target</a></li><li><a href="#get_target_interfaces" class="table-of-contents__link toc-highlight">get_target_interfaces</a></li></ul></li><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a><ul><li><a href="#get_interface-since-500" class="table-of-contents__link toc-highlight">get_interface (since 5.0.0)</a></li><li><a href="#get_interface_names" class="table-of-contents__link toc-highlight">get_interface_names</a></li><li><a href="#connect_interface" class="table-of-contents__link toc-highlight">connect_interface</a></li><li><a href="#disconnect_interface" class="table-of-contents__link toc-highlight">disconnect_interface</a></li><li><a href="#start_raw_logging_interface" class="table-of-contents__link toc-highlight">start_raw_logging_interface</a></li><li><a href="#stop_raw_logging_interface" class="table-of-contents__link toc-highlight">stop_raw_logging_interface</a></li><li><a href="#get_all_interface_info" class="table-of-contents__link toc-highlight">get_all_interface_info</a></li><li><a href="#map_target_to_interface" class="table-of-contents__link toc-highlight">map_target_to_interface</a></li><li><a href="#interface_cmd" class="table-of-contents__link toc-highlight">interface_cmd</a></li><li><a href="#interface_protocol_cmd" class="table-of-contents__link toc-highlight">interface_protocol_cmd</a></li></ul></li><li><a href="#routers" class="table-of-contents__link toc-highlight">Routers</a><ul><li><a href="#connect_router" class="table-of-contents__link toc-highlight">connect_router</a></li><li><a href="#disconnect_router" class="table-of-contents__link toc-highlight">disconnect_router</a></li><li><a href="#get_router_names" class="table-of-contents__link toc-highlight">get_router_names</a></li><li><a href="#get_router-since-500" class="table-of-contents__link toc-highlight">get_router (since 5.0.0)</a></li><li><a href="#get_all_router_info" class="table-of-contents__link toc-highlight">get_all_router_info</a></li><li><a href="#start_raw_logging_router" class="table-of-contents__link toc-highlight">start_raw_logging_router</a></li><li><a href="#stop_raw_logging_router" class="table-of-contents__link toc-highlight">stop_raw_logging_router</a></li><li><a href="#router_cmd" class="table-of-contents__link toc-highlight">router_cmd</a></li><li><a href="#router_protocol_cmd" class="table-of-contents__link toc-highlight">router_protocol_cmd</a></li></ul></li><li><a href="#stashing-data" class="table-of-contents__link toc-highlight">Stashing Data</a><ul><li><a href="#stash_set" class="table-of-contents__link toc-highlight">stash_set</a></li><li><a href="#stash_get" class="table-of-contents__link toc-highlight">stash_get</a></li><li><a href="#stash_all" class="table-of-contents__link toc-highlight">stash_all</a></li><li><a href="#stash_keys" class="table-of-contents__link toc-highlight">stash_keys</a></li><li><a href="#stash_delete" class="table-of-contents__link toc-highlight">stash_delete</a></li></ul></li><li><a href="#executing-other-procedures" class="table-of-contents__link toc-highlight">Executing Other Procedures</a><ul><li><a href="#start" class="table-of-contents__link toc-highlight">start</a></li><li><a href="#load_utility" class="table-of-contents__link toc-highlight">load_utility</a></li></ul></li><li><a href="#opening-closing--creating-telemetry-screens" class="table-of-contents__link toc-highlight">Opening, Closing & Creating Telemetry Screens</a><ul><li><a href="#display_screen" class="table-of-contents__link toc-highlight">display_screen</a></li><li><a href="#clear_screen" class="table-of-contents__link toc-highlight">clear_screen</a></li><li><a href="#clear_all_screens" class="table-of-contents__link toc-highlight">clear_all_screens</a></li><li><a href="#delete_screen" class="table-of-contents__link toc-highlight">delete_screen</a></li><li><a href="#get_screen_list" class="table-of-contents__link toc-highlight">get_screen_list</a></li><li><a href="#get_screen_definition" class="table-of-contents__link toc-highlight">get_screen_definition</a></li><li><a href="#create_screen" class="table-of-contents__link toc-highlight">create_screen</a></li><li><a href="#local_screen" class="table-of-contents__link toc-highlight">local_screen</a></li></ul></li><li><a href="#script-runner-settings" class="table-of-contents__link toc-highlight">Script Runner Settings</a><ul><li><a href="#set_line_delay" class="table-of-contents__link toc-highlight">set_line_delay</a></li><li><a href="#get_line_delay" class="table-of-contents__link toc-highlight">get_line_delay</a></li><li><a href="#set_max_output" class="table-of-contents__link toc-highlight">set_max_output</a></li><li><a href="#get_max_output" class="table-of-contents__link toc-highlight">get_max_output</a></li><li><a href="#disable_instrumentation" class="table-of-contents__link toc-highlight">disable_instrumentation</a></li></ul></li><li><a href="#script-runner-suites" class="table-of-contents__link toc-highlight">Script Runner Suites</a><ul><li><a href="#add_group-add_group_setup-add_group_teardown-add_script" class="table-of-contents__link toc-highlight">add_group, add_group_setup, add_group_teardown, add_script</a></li></ul></li><li><a href="#script-runner-debugging" class="table-of-contents__link toc-highlight">Script Runner Debugging</a><ul><li><a href="#step_mode" class="table-of-contents__link toc-highlight">step_mode</a></li><li><a href="#run_mode" class="table-of-contents__link toc-highlight">run_mode</a></li><li><a href="#disconnect_script" class="table-of-contents__link toc-highlight">disconnect_script</a></li></ul></li><li><a href="#metadata" class="table-of-contents__link toc-highlight">Metadata</a><ul><li><a href="#metadata_all" class="table-of-contents__link toc-highlight">metadata_all</a></li><li><a href="#metadata_get" class="table-of-contents__link toc-highlight">metadata_get</a></li><li><a href="#metadata_set" class="table-of-contents__link toc-highlight">metadata_set</a></li><li><a href="#metadata_update" class="table-of-contents__link toc-highlight">metadata_update</a></li><li><a href="#metadata_input" class="table-of-contents__link toc-highlight">metadata_input</a></li></ul></li><li><a href="#settings" class="table-of-contents__link toc-highlight">Settings</a><ul><li><a href="#list_settings" class="table-of-contents__link toc-highlight">list_settings</a></li><li><a href="#get_all_settings" class="table-of-contents__link toc-highlight">get_all_settings</a></li><li><a href="#get_setting-get_settings" class="table-of-contents__link toc-highlight">get_setting, get_settings</a></li><li><a href="#set_setting" class="table-of-contents__link toc-highlight">set_setting</a></li></ul></li><li><a href="#configuration" class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href="#config_tool_names" class="table-of-contents__link toc-highlight">config_tool_names</a></li><li><a href="#list_configs" class="table-of-contents__link toc-highlight">list_configs</a></li><li><a href="#load_config" class="table-of-contents__link toc-highlight">load_config</a></li><li><a href="#save_config" class="table-of-contents__link toc-highlight">save_config</a></li><li><a href="#delete_config" class="table-of-contents__link toc-highlight">delete_config</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
1072
1072
|
</body>
|
1073
1073
|
</html>
|