openc3-cosmos-tool-docs 6.8.1 → 6.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/Rakefile +1 -1
- data/tools/staticdocs/404.html +2 -2
- data/tools/staticdocs/assets/css/styles.946be27d.css +1 -0
- data/tools/staticdocs/assets/images/activity-35dc5e3ab907ff79a599ab728b7a4ace155d86835a09f0c6fa8ceebf184b7984.png +0 -0
- data/tools/staticdocs/assets/images/blank_calendar-e02977fafde5379efc62fbaf82686898bfc4745dd081d62e52e3ee94c46bff69.png +0 -0
- data/tools/staticdocs/assets/images/cmd_packets-e7906db3691ccd29600e09cf005f6f53be9d9332ba4c319a1e81e1c8c6b665ed.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-117772d4be1adbf89805f5b530da301b3dcc0d5085a552d779c9bc692bac4c44.png +0 -0
- data/tools/staticdocs/assets/images/create_activity1-5e5a8cee97e818c21e3447d96797b950fe25eb5d0e153ffc899183d28b7fd1be.png +0 -0
- data/tools/staticdocs/assets/images/create_activity2-12024f05a06874c9e7b544bac4bec1a263de1715dcb9fa2dc1aea054682e8269.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata1-70387fe6ea1aafaee24b4192e76000b31ed60d3a54f957d761cefb5d21498814.png +0 -0
- data/tools/staticdocs/assets/images/create_metadata2-ebb8f148142b387c81df70f8a565b27942ff5f6cd5bc098a6d58a27a9b36c09e.png +0 -0
- data/tools/staticdocs/assets/images/create_note1-28feb5cf0ad0899db78059dc4ea2567dc9cb03c8c776f1c65dd959f2910481f4.png +0 -0
- data/tools/staticdocs/assets/images/create_note2-c0929ea9194606f256465cd6a6c97c60c175cf2ecbf56e6597d4886b4249fe1f.png +0 -0
- data/tools/staticdocs/assets/images/data_flows-6796d95b379f3f69e3fcf9629c68aae389f3d9a287db5b4d0bbc385d478134b4.png +0 -0
- data/tools/staticdocs/assets/images/gantt_view-3fe75622572f4a5bab2f73311127b71db5bf5aed475b90a2938c9ae61810ea54.png +0 -0
- data/tools/staticdocs/assets/images/interface_details-b71797d470007be1e0520bb5b859b4da9cd3411303388be9e6db914a99628dff.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-05db0ed276077b796b54a3bca76bd0841bfb0d700456258c878359d332ff9f8f.png +0 -0
- data/tools/staticdocs/assets/images/list_view-edfc7b6fa90e43b85dd862f06c3662dee33b3c79be923a955706001d2f07eca4.png +0 -0
- data/tools/staticdocs/assets/images/options-4cb5e315138437db9f25c87feb4be2c61738c03bc3344d46977f44a94b0af738.png +0 -0
- data/tools/staticdocs/assets/images/protocol_details-408f871b0bd8440091ac95ca76cac353bb06d0b3a6c3f756dd11e7e746d7c20c.png +0 -0
- data/tools/staticdocs/assets/images/status-9b7ac4d919d196a2bf3379d0cb262c6609fb98074c744533bb9132097cb52155.png +0 -0
- data/tools/staticdocs/assets/images/targets-b07f7cd9f19a4ca02d2838a4de58c25168f01ee256e692878e3b27b833632aca.png +0 -0
- data/tools/staticdocs/assets/images/timeline-78e3ab74af1b600eb6640831133f0240a9c20047956b18b729263988a66b8e00.png +0 -0
- data/tools/staticdocs/assets/images/tlm_packets-18345c00fd6cc01a9f7a1e363fdf8375769ba5afa4ccf22c45925184eefc57ca.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.64763f3d.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.3d58085e.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +1 -0
- data/tools/staticdocs/assets/js/{0f5d161c.0727eb1b.js → 0f5d161c.978b9fee.js} +1 -1
- data/tools/staticdocs/assets/js/0ff569c9.27128023.js +1 -0
- data/tools/staticdocs/assets/js/10209fc9.669ef887.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.1a538098.js +1 -0
- data/tools/staticdocs/assets/js/13196248.e93bfd65.js +1 -0
- data/tools/staticdocs/assets/js/{13c1b4e4.6446ccbc.js → 13c1b4e4.9735bb59.js} +1 -1
- data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +1 -0
- data/tools/staticdocs/assets/js/{1e02e6a3.a89f2446.js → 1e02e6a3.da7b7250.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.0955283c.js → 2047b354.c86efa5f.js} +1 -1
- data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.858cb22d.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +1 -0
- data/tools/staticdocs/assets/js/3326.2db66e1b.js +4 -0
- data/tools/staticdocs/assets/js/3402.80344ef5.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +1 -0
- data/tools/staticdocs/assets/js/{3dd7ef3b.f43cd057.js → 3dd7ef3b.ceb26a04.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.f6769d57.js +1 -0
- data/tools/staticdocs/assets/js/4071.821f3b2b.js +1 -0
- data/tools/staticdocs/assets/js/{411898ad.28293824.js → 411898ad.8ed3452c.js} +1 -1
- data/tools/staticdocs/assets/js/42170351.7ff72adc.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +1 -0
- data/tools/staticdocs/assets/js/5072.9a0a2752.js +1 -0
- data/tools/staticdocs/assets/js/{53ca7c5b.9468b8ed.js → 53ca7c5b.3ae5bb0f.js} +1 -1
- data/tools/staticdocs/assets/js/54d0d530.2f7aa091.js +1 -0
- data/tools/staticdocs/assets/js/5525.dd1645b0.js +101 -0
- data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.821e5ed4.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +1 -0
- data/tools/staticdocs/assets/js/6246.60dfff30.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.dc5bae56.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.d197d085.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d400f853.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.1bbde831.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.338d2338.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +1 -0
- data/tools/staticdocs/assets/js/{8434.a3e5442b.js → 9623.44668503.js} +1 -1
- data/tools/staticdocs/assets/js/{964eb012.4253acd5.js → 964eb012.c7f626c5.js} +1 -1
- data/tools/staticdocs/assets/js/97535711.a6342866.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +1 -0
- data/tools/staticdocs/assets/js/{9d6e81d0.b9f15524.js → 9d6e81d0.879c9e9e.js} +1 -1
- data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.758701f0.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.b566ee29.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.9e7f0be7.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +1 -0
- data/tools/staticdocs/assets/js/{b9f60ba6.2c4823f0.js → b9f60ba6.63638354.js} +1 -1
- data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +1 -0
- data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +1 -0
- data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.e29ff552.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.4e811739.js +1 -0
- data/tools/staticdocs/assets/js/{dc5f7beb.15b70d4b.js → dc5f7beb.c703e464.js} +1 -1
- data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.8591b830.js +1 -0
- data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +1 -0
- data/tools/staticdocs/assets/js/{fd886806.f7bfd80c.js → fd886806.fb8a587e.js} +1 -1
- data/tools/staticdocs/assets/js/main.2bcd58cc.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +46 -46
- data/tools/staticdocs/docs/configuration/command.html +97 -97
- data/tools/staticdocs/docs/configuration/conversions.html +53 -53
- data/tools/staticdocs/docs/configuration/format.html +22 -22
- data/tools/staticdocs/docs/configuration/interfaces.html +55 -55
- data/tools/staticdocs/docs/configuration/limits-response.html +10 -10
- data/tools/staticdocs/docs/configuration/plugins.html +127 -127
- data/tools/staticdocs/docs/configuration/processors.html +17 -17
- data/tools/staticdocs/docs/configuration/protocols.html +66 -66
- data/tools/staticdocs/docs/configuration/ssl-tls.html +15 -15
- data/tools/staticdocs/docs/configuration/table.html +53 -53
- data/tools/staticdocs/docs/configuration/target.html +21 -21
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +289 -289
- data/tools/staticdocs/docs/configuration/telemetry.html +86 -86
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +14 -14
- data/tools/staticdocs/docs/development/developing.html +27 -27
- data/tools/staticdocs/docs/development/json-api.html +15 -15
- data/tools/staticdocs/docs/development/log-structure.html +13 -13
- data/tools/staticdocs/docs/development/roadmap.html +4 -4
- data/tools/staticdocs/docs/development/streaming-api.html +24 -24
- data/tools/staticdocs/docs/development/testing.html +20 -20
- data/tools/staticdocs/docs/development.html +2 -2
- data/tools/staticdocs/docs/getting-started/cli.html +39 -39
- data/tools/staticdocs/docs/getting-started/generators.html +25 -25
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +19 -19
- data/tools/staticdocs/docs/getting-started/installation.html +23 -21
- data/tools/staticdocs/docs/getting-started/key-concepts.html +20 -20
- data/tools/staticdocs/docs/getting-started/podman.html +23 -23
- data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
- data/tools/staticdocs/docs/getting-started/upgrading.html +47 -47
- data/tools/staticdocs/docs/getting-started.html +2 -2
- data/tools/staticdocs/docs/guides/bridges.html +19 -12
- data/tools/staticdocs/docs/guides/cfs.html +32 -32
- data/tools/staticdocs/docs/guides/custom-widgets.html +36 -36
- data/tools/staticdocs/docs/guides/dynamic-packets.html +8 -8
- data/tools/staticdocs/docs/guides/exposing-microservices.html +11 -11
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +4 -4
- data/tools/staticdocs/docs/guides/local-mode.html +13 -13
- data/tools/staticdocs/docs/guides/logging.html +9 -9
- data/tools/staticdocs/docs/guides/monitoring.html +18 -18
- data/tools/staticdocs/docs/guides/performance.html +10 -10
- data/tools/staticdocs/docs/guides/raspberrypi.html +4 -4
- data/tools/staticdocs/docs/guides/reference-architectures.html +6 -6
- data/tools/staticdocs/docs/guides/script-writing.html +80 -80
- data/tools/staticdocs/docs/guides/scripting-api.html +715 -635
- data/tools/staticdocs/docs/guides/troubleshooting.html +8 -7
- data/tools/staticdocs/docs/guides.html +2 -2
- data/tools/staticdocs/docs/meta/contributing.html +12 -12
- data/tools/staticdocs/docs/meta/licenses.html +9 -9
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/xtce.html +12 -12
- data/tools/staticdocs/docs/meta.html +2 -2
- data/tools/staticdocs/docs/privacy.html +17 -17
- data/tools/staticdocs/docs/tools/admin.html +24 -24
- data/tools/staticdocs/docs/tools/autonomic.html +19 -19
- data/tools/staticdocs/docs/tools/bucket-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/calendar.html +34 -21
- data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +31 -22
- data/tools/staticdocs/docs/tools/command-history.html +6 -6
- data/tools/staticdocs/docs/tools/command-queue.html +8 -8
- data/tools/staticdocs/docs/tools/data-extractor.html +25 -25
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -11
- data/tools/staticdocs/docs/tools/handbooks.html +4 -4
- data/tools/staticdocs/docs/tools/limits-monitor.html +16 -16
- data/tools/staticdocs/docs/tools/log-explorer.html +9 -9
- data/tools/staticdocs/docs/tools/packet-viewer.html +12 -12
- data/tools/staticdocs/docs/tools/script-runner.html +43 -43
- data/tools/staticdocs/docs/tools/systemhealth.html +21 -21
- data/tools/staticdocs/docs/tools/table-manager.html +11 -11
- data/tools/staticdocs/docs/tools/tlm-grapher.html +22 -22
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +11 -11
- data/tools/staticdocs/img/calendar/activity.png +0 -0
- data/tools/staticdocs/img/calendar/blank_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/gantt_view.png +0 -0
- data/tools/staticdocs/img/calendar/list_view.png +0 -0
- data/tools/staticdocs/img/calendar/options.png +0 -0
- data/tools/staticdocs/img/calendar/timeline.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_packets.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/data_flows.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/interface_details.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/interfaces.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/protocol_details.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/index.html +2 -2
- data/tools/staticdocs/lunr-index-1759687174225.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +3 -3
- data/tools/staticdocs/search-doc-1759687174225.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +120 -107
- data/tools/staticdocs/assets/css/styles.0edf3032.css +0 -1
- data/tools/staticdocs/assets/images/blank_calendar-70e605942120937b862bd7039348229bab9af1f9c93d356ddbf401a3e8543c74.png +0 -0
- data/tools/staticdocs/assets/images/calendar-dacbcbb05175c76f3406b4aaade0465444c20b72e93366c79fed1f6eec018c42.png +0 -0
- data/tools/staticdocs/assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.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/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png +0 -0
- data/tools/staticdocs/assets/images/list_view-2f36ce06962e67d5a4f1f060956e5089b3f13c8ab57f33103c3781687611e7a9.png +0 -0
- data/tools/staticdocs/assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png +0 -0
- data/tools/staticdocs/assets/images/targets-6b17daf175185b13bea9eddafd4773e5f41d1ef4e953134f30bee0799c1e5c31.png +0 -0
- data/tools/staticdocs/assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5366d64b.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.31b5fa22.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.eb311155.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.974abc47.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.c8815d72.js +0 -1
- data/tools/staticdocs/assets/js/10209fc9.ae369363.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.32c30401.js +0 -1
- data/tools/staticdocs/assets/js/1085.d1eba438.js +0 -1
- data/tools/staticdocs/assets/js/1319.d9ec0592.js +0 -101
- data/tools/staticdocs/assets/js/13196248.9e1ebaa5.js +0 -1
- data/tools/staticdocs/assets/js/1c0a0c05.a24e9a5c.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.81906212.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.9d3cbdeb.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.a04c2a3c.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.38a25aed.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.d3ee7838.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.db29df30.js +0 -1
- data/tools/staticdocs/assets/js/42170351.c5a07a3b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.35825078.js +0 -1
- data/tools/staticdocs/assets/js/5074.653f3924.js +0 -1
- data/tools/staticdocs/assets/js/5410.60ab1dba.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.dfcfecc5.js +0 -1
- data/tools/staticdocs/assets/js/59ed27a4.8eb3444b.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.814a9779.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.ea5fa091.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.dde1bfbc.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.6deb22ed.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.622c8b76.js +0 -1
- data/tools/staticdocs/assets/js/6242.bdac32c1.js +0 -4
- data/tools/staticdocs/assets/js/6831b732.7cf97282.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.b96d263c.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.75ed74f4.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.8ceb772d.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.11fea7a0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.241ba59b.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.c8cb1f1a.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.a02df5f7.js +0 -1
- data/tools/staticdocs/assets/js/8851.4837d29a.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.cdd88da3.js +0 -1
- data/tools/staticdocs/assets/js/8b939c74.c9ac09c3.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.676b5d36.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.a3b9746a.js +0 -1
- data/tools/staticdocs/assets/js/97535711.2a29c3e7.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.791cdc39.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.5f39bd90.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.2695e35a.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.71b17b00.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.c8eb51b6.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.2d0fadd1.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.e240f32e.js +0 -1
- data/tools/staticdocs/assets/js/b38a6d74.7363be85.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.2a473696.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.dda7b69f.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.7282117c.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.60c8e0c8.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.2466362b.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.6a299bce.js +0 -1
- data/tools/staticdocs/assets/js/cf1c01b8.1913e9f8.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.482b8f7b.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.ada87033.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.2b9e8d63.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.bf08c8f5.js +0 -1
- data/tools/staticdocs/assets/js/d59d8a14.479869f6.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.199e159b.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.210077a2.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.57f74139.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.015f5324.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.1c778ff1.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.37d6f071.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.c42aad75.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.a8a415cb.js +0 -1
- data/tools/staticdocs/assets/js/f75a5f33.4d2501bc.js +0 -1
- data/tools/staticdocs/assets/js/main.994f9f74.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.44311138.js +0 -1
- data/tools/staticdocs/lunr-index-1757781681330.json +0 -1
- data/tools/staticdocs/search-doc-1757781681330.json +0 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/little-endian-bitfields" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/little-endian-bitfields" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Little Endian Bitfields | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/guides/little-endian-bitfields /><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="Little Endian Bitfields | OpenC3 Docs"/><meta data-rh=true name=description content="Defining little endian bitfields"/><meta data-rh=true property=og:description content="Defining little endian bitfields"/><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/little-endian-bitfields /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/little-endian-bitfields hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/little-endian-bitfields hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/little-endian-bitfields","name":"Little Endian Bitfields","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
|
-
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures>Reference Architectures</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting>Troubleshooting</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Little Endian Bitfields</span></ul></nav><div class="theme-doc-markdown markdown"><header><h1>Little Endian Bitfields</h1></header><p>Defining little endian bitfields is a little weird but is possible in COSMOS. However, note that APPEND does not work with little endian bitfields.</p>
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges><span title=Bridges class=linkLabel_THKR>Bridges</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs><span title="COSMOS and NASA cFS" class=linkLabel_THKR>COSMOS and NASA cFS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets><span title="Custom Widgets" class=linkLabel_THKR>Custom Widgets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets><span title="Dynamic Packets" class=linkLabel_THKR>Dynamic Packets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices><span title="Exposing Microservices" class=linkLabel_THKR>Exposing Microservices</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields><span title="Little Endian Bitfields" class=linkLabel_THKR>Little Endian Bitfields</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode><span title="Local Mode" class=linkLabel_THKR>Local Mode</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging><span title=Logging class=linkLabel_THKR>Logging</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring><span title=Monitoring class=linkLabel_THKR>Monitoring</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance><span title=Performance class=linkLabel_THKR>Performance</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi><span title="Raspberry Pi" class=linkLabel_THKR>Raspberry Pi</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures><span title="Reference Architectures" class=linkLabel_THKR>Reference Architectures</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing><span title="Script Writing Guide" class=linkLabel_THKR>Script Writing Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api><span title="Scripting API Guide" class=linkLabel_THKR>Scripting API Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting><span title=Troubleshooting class=linkLabel_THKR>Troubleshooting</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Little Endian Bitfields</span></ul></nav><div class="theme-doc-markdown markdown"><header><h1>Little Endian Bitfields</h1></header><p>Defining little endian bitfields is a little weird but is possible in COSMOS. However, note that APPEND does not work with little endian bitfields.</p>
|
|
5
5
|
<p>Here are the rules on how COSMOS handles LITTLE_ENDIAN data:</p>
|
|
6
6
|
<ol>
|
|
7
7
|
<li>
|
|
@@ -17,6 +17,6 @@
|
|
|
17
17
|
<p>LITTLE_ENDIAN bit fields must define their bit_offset as the location of the most significant bit of the bitfield in BIG_ENDIAN space as described in rule 1 above. So for example. The following C struct at the beginning of a packet would be defined like so:</p>
|
|
18
18
|
</li>
|
|
19
19
|
</ol>
|
|
20
|
-
<div class="language-c
|
|
20
|
+
<div class="language-c codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-c codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">struct</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">unsigned</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">short</span><span class="token plain"> a</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token 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)">unsigned</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">short</span><span class="token plain"> b</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token number" style="color:rgb(247, 140, 108)">8</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)">unsigned</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">short</span><span class="token plain"> c</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token 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">ITEM A </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> UINT </span><span class="token string" style="color:rgb(173, 219, 103)">"struct item a"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">ITEM B </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> UINT </span><span class="token string" style="color:rgb(173, 219, 103)">"struct item b"</span><span class="token plain"></span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">ITEM C </span><span class="token number" style="color:rgb(247, 140, 108)">8</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> UINT </span><span class="token string" style="color:rgb(173, 219, 103)">"struct item c"</span><br/></span></code></pre></div></div>
|
|
21
21
|
<p>This is hard to visualize, but the structure above gets spread out in a byte array like the following after byte swapping: least significant 4 bits of b, 4-bits a, 4-bits c, most significant 4 bits of b.</p>
|
|
22
|
-
<p>The best advice is to experiment and use the View Raw feature in the Command and Telemetry Service to inspect the bytes of the packet and adjust as necessary.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/little-endian-bitfields.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=
|
|
22
|
+
<p>The best advice is to experiment and use the View Raw feature in the Command and Telemetry Service to inspect the bytes of the packet and adjust as necessary.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/little-endian-bitfields.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/exposing-microservices><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Exposing Microservices</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/local-mode><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Local Mode</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/local-mode" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/local-mode" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Local Mode | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/guides/local-mode /><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="Local Mode | OpenC3 Docs"/><meta data-rh=true name=description content="Edit scripts and screens directly on the host file system"/><meta data-rh=true property=og:description content="Edit scripts and screens directly on the host file system"/><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/local-mode /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/local-mode hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/local-mode hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/local-mode","name":"Local Mode","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
|
-
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures>Reference Architectures</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting>Troubleshooting</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Local Mode</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Local Mode</h1></header><p>Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions.</p>
|
|
5
|
-
<h2 class="anchor
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges><span title=Bridges class=linkLabel_THKR>Bridges</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs><span title="COSMOS and NASA cFS" class=linkLabel_THKR>COSMOS and NASA cFS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets><span title="Custom Widgets" class=linkLabel_THKR>Custom Widgets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets><span title="Dynamic Packets" class=linkLabel_THKR>Dynamic Packets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices><span title="Exposing Microservices" class=linkLabel_THKR>Exposing Microservices</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields><span title="Little Endian Bitfields" class=linkLabel_THKR>Little Endian Bitfields</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/local-mode><span title="Local Mode" class=linkLabel_THKR>Local Mode</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/logging><span title=Logging class=linkLabel_THKR>Logging</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring><span title=Monitoring class=linkLabel_THKR>Monitoring</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance><span title=Performance class=linkLabel_THKR>Performance</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi><span title="Raspberry Pi" class=linkLabel_THKR>Raspberry Pi</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures><span title="Reference Architectures" class=linkLabel_THKR>Reference Architectures</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing><span title="Script Writing Guide" class=linkLabel_THKR>Script Writing Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api><span title="Scripting API Guide" class=linkLabel_THKR>Scripting API Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting><span title=Troubleshooting class=linkLabel_THKR>Troubleshooting</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Local Mode</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Local Mode</h1></header><p>Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions.</p>
|
|
5
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=using-local-mode>Using Local Mode<a href=#using-local-mode class=hash-link aria-label="Direct link to Using Local Mode" title="Direct link to Using Local Mode" translate=no></a></h2>
|
|
6
6
|
<p>In this tutorial we will use the COSMOS Demo as configured by the <a href=/tools/staticdocs/docs/getting-started/installation>Installation Guide</a>. You should have cloned a <a href=https://github.com/OpenC3/cosmos-project target=_blank rel="noopener noreferrer">cosmos-project</a> and started it using <code>openc3.sh run</code>.</p>
|
|
7
7
|
<p>If you check the project directory you should see a <code>plugins/DEFAULT/openc3-cosmos-demo</code> directory. This will contain both the gem that was installed and a <code>plugin_instance.json</code> file. The <code>plugin_instance.json</code> file captures the plugin.txt values when the plugin was installed. Note, all files in the plugins directory are meant to be configuration managed with the project. This ensures if you make local edits and check them in, another user can clone the project and get the exact same configuration. We will demonstrate this later.</p>
|
|
8
|
-
<h3 class="anchor
|
|
9
|
-
<div class="theme-admonition theme-admonition-info
|
|
8
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=editing-scripts>Editing scripts<a href=#editing-scripts class=hash-link aria-label="Direct link to Editing scripts" title="Direct link to Editing scripts" translate=no></a></h3>
|
|
9
|
+
<div class="theme-admonition theme-admonition-info admonition_AUqJ alert alert--info"><div class=admonitionHeading_V_Ab><span class=admonitionIcon_ZQS8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Visual Studio Code</div><div class=admonitionContent_ISwi><p>This tutorial will use <a href=https://code.visualstudio.com target=_blank rel="noopener noreferrer">VS Code</a> which is the editor used by the COSMOS developers.</div></div>
|
|
10
10
|
<p>The most common use case for Local Mode is script development. Launch Script Runner and open the <code>INST/procedures/checks.rb</code> file. If you run this script you'll notice that it has a few errors (by design) which prevent it from running to completion. Let's fix it! Comment out lines 7 & 9 and save the script. You should now notice that Local Mode has saved a copy of the script to <code>plugins/targets_modified/INST/procedures/checks.rb</code>.</p>
|
|
11
|
-
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/project-c521374330008c1292b4da1b9a1c8af6647ab59f1617b470f26e76a521fe8059.png width=991 height=547 class=
|
|
11
|
+
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/project-c521374330008c1292b4da1b9a1c8af6647ab59f1617b470f26e76a521fe8059.png width=991 height=547 class=img_m1Wr /></p>
|
|
12
12
|
<p>At this point Local Mode keeps these scripts in sync so we can edit in either place. Let's edit the local script by adding a simple comment at the top: <code># This is a script</code>. Now if we go back to Script Runner the changes have not <em>automatically</em> appeared. However, there is a Reload button next to the filename that will refresh the file from the backend.</p>
|
|
13
|
-
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/reload_file-056b240b1d48539a9fecfe2ad1bac0c27d83f5dddcd29af6cf719986869406ee.png width=839 height=532 class=
|
|
13
|
+
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/reload_file-056b240b1d48539a9fecfe2ad1bac0c27d83f5dddcd29af6cf719986869406ee.png width=839 height=532 class=img_m1Wr /></p>
|
|
14
14
|
<p>Clicking this reloads the file which has been synced into COSMOS and now we see our comment.</p>
|
|
15
|
-
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/reloaded-516bc4c257f9b7f6ce3714f5a06eeef8ad47a8461e21613ba26989d5e56260ec.png width=839 height=232 class=
|
|
16
|
-
<h3 class="anchor
|
|
15
|
+
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/reloaded-516bc4c257f9b7f6ce3714f5a06eeef8ad47a8461e21613ba26989d5e56260ec.png width=839 height=232 class=img_m1Wr /></p>
|
|
16
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=disabling-local-mode>Disabling Local Mode<a href=#disabling-local-mode class=hash-link aria-label="Direct link to Disabling Local Mode" title="Direct link to Disabling Local Mode" translate=no></a></h3>
|
|
17
17
|
<p>If you want to disable Local Mode you can edit the .env file and delete the setting <code>OPENC3_LOCAL_MODE=1</code>.</p>
|
|
18
|
-
<h2 class="anchor
|
|
18
|
+
<h2 class="anchor anchorWithStickyNavbar_TUrh" id=configuration-management>Configuration Management<a href=#configuration-management class=hash-link aria-label="Direct link to Configuration Management" title="Direct link to Configuration Management" translate=no></a></h2>
|
|
19
19
|
<p>It is recommended to configuration manage the entire project including the plugins directory. This will allow any user who starts COSMOS to launch an identical configuration. Plugins are created and updated with any modifications found in the targets_modified directory.</p>
|
|
20
20
|
<p>At some point you will probably want to release your local changes back to the plugin they originated from. Simply copy the entire targets_modified/TARGET directory back to the original plugin. At that point you can rebuild the plugin using the CLI.</p>
|
|
21
|
-
<div class="language-text
|
|
21
|
+
<div class="language-text codeBlockContainer_pOyF theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_OnWH><pre tabindex=0 class="prism-code language-text codeBlock_mQyU thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_oRU6><span class=token-line style=color:#d6deeb><span class="token plain">openc3-cosmos-demo % ./openc3.sh cli rake build VERSION=1.0.1</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> Successfully built RubyGem</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> Name: openc3-cosmos-demo</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> Version: 1.0.1</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain"> File: openc3-cosmos-demo-1.0.1.gem</span><br/></span></code></pre></div></div>
|
|
22
22
|
<p>Upgrade the plugin using the Admin Plugins tab and the Upgrade link. When you select your newly built plugin, COSMOS detects the existing changes and asks if you want to delete them. There is a stern warning attached because this will permanently remove these changes! Since we just moved over the changes and rebuilt the plugin we will check the box and INSTALL.</p>
|
|
23
|
-
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/delete_modified-ecf9beabf5e6cc6b8cc9d249ba9e313bd18d51c671ebc36029b4cebd729fa2d0.png width=1272 height=619 class=
|
|
23
|
+
<p><img decoding=async loading=lazy alt="Project Layout" src=/tools/staticdocs/assets/images/delete_modified-ecf9beabf5e6cc6b8cc9d249ba9e313bd18d51c671ebc36029b4cebd729fa2d0.png width=1272 height=619 class=img_m1Wr /></p>
|
|
24
24
|
<p>When the new plugin is installed, the project's <code>plugins</code> directory gets updated with the new plugin and everything under the targets_modified directory is removed because there are no modifications on a new install.</p>
|
|
25
|
-
<p>Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/local-mode.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=
|
|
25
|
+
<p>Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/local-mode.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/little-endian-bitfields><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Little Endian Bitfields</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/logging><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Logging</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#using-local-mode class="table-of-contents__link toc-highlight">Using Local Mode</a><ul><li><a href=#editing-scripts class="table-of-contents__link toc-highlight">Editing scripts</a><li><a href=#disabling-local-mode class="table-of-contents__link toc-highlight">Disabling Local Mode</a></ul><li><a href=#configuration-management class="table-of-contents__link toc-highlight">Configuration Management</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/logging" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.
|
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-guides/logging" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Logging | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/guides/logging /><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="Logging | OpenC3 Docs"/><meta data-rh=true name=description content="The log files in COSMOS"/><meta data-rh=true property=og:description content="The log files in COSMOS"/><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/logging /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/logging hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/guides/logging hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides","name":"Guides","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/guides/logging","name":"Logging","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.0b4f5e9a.js defer></script><script src=/tools/staticdocs/assets/js/main.2bcd58cc.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
|
|
2
2
|
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
3
3
|
</defs></svg>
|
|
4
|
-
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges>Bridges</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs>COSMOS and NASA cFS</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets>Custom Widgets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets>Dynamic Packets</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices>Exposing Microservices</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields>Little Endian Bitfields</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode>Local Mode</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/logging>Logging</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring>Monitoring</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance>Performance</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi>Raspberry Pi</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures>Reference Architectures</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing>Script Writing Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api>Scripting API Guide</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting>Troubleshooting</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Logging</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Logging</h1></header><p>The COSMOS <a href=/tools/staticdocs/docs/tools/bucket-explorer>Bucket Explorer</a> tool provides a way to browse the COSMOS bucket storage backend whether you are running locally or in a cloud environment. Browse to <a href=http://localhost:2900/tools/bucketexplorer target=_blank rel="noopener noreferrer">http://localhost:2900/tools/bucketexplorer</a> and you should see the list of buckets at the top:</p>
|
|
5
|
-
<p><img decoding=async loading=lazy alt="Bucket Explorer" src=/tools/staticdocs/assets/images/logs-bfc2ef93f6e60cb3bdf409aaaf0b4315b6e98dc1b9c17bdc171e67b416d884cc.png width=1272 height=570 class=
|
|
4
|
+
<script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Expand sidebar category 'Getting Started'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Collapse sidebar category 'Guides'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/bridges><span title=Bridges class=linkLabel_THKR>Bridges</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/cfs><span title="COSMOS and NASA cFS" class=linkLabel_THKR>COSMOS and NASA cFS</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/custom-widgets><span title="Custom Widgets" class=linkLabel_THKR>Custom Widgets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/dynamic-packets><span title="Dynamic Packets" class=linkLabel_THKR>Dynamic Packets</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/exposing-microservices><span title="Exposing Microservices" class=linkLabel_THKR>Exposing Microservices</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/little-endian-bitfields><span title="Little Endian Bitfields" class=linkLabel_THKR>Little Endian Bitfields</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/local-mode><span title="Local Mode" class=linkLabel_THKR>Local Mode</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/guides/logging><span title=Logging class=linkLabel_THKR>Logging</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/monitoring><span title=Monitoring class=linkLabel_THKR>Monitoring</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/performance><span title=Performance class=linkLabel_THKR>Performance</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/raspberrypi><span title="Raspberry Pi" class=linkLabel_THKR>Raspberry Pi</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/reference-architectures><span title="Reference Architectures" class=linkLabel_THKR>Reference Architectures</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/script-writing><span title="Script Writing Guide" class=linkLabel_THKR>Script Writing Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/scripting-api><span title="Scripting API Guide" class=linkLabel_THKR>Scripting API Guide</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/guides/troubleshooting><span title=Troubleshooting class=linkLabel_THKR>Troubleshooting</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_rdr9"><div class=docItemContainer_jIg7><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/guides><span>Guides</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Logging</span></ul></nav><div class="tocCollapsible_xgee theme-doc-toc-mobile tocMobile_JnGb"><button type=button class="clean-btn tocCollapsibleButton_c5np">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Logging</h1></header><p>The COSMOS <a href=/tools/staticdocs/docs/tools/bucket-explorer>Bucket Explorer</a> tool provides a way to browse the COSMOS bucket storage backend whether you are running locally or in a cloud environment. Browse to <a href=http://localhost:2900/tools/bucketexplorer target=_blank rel="noopener noreferrer">http://localhost:2900/tools/bucketexplorer</a> and you should see the list of buckets at the top:</p>
|
|
5
|
+
<p><img decoding=async loading=lazy alt="Bucket Explorer" src=/tools/staticdocs/assets/images/logs-bfc2ef93f6e60cb3bdf409aaaf0b4315b6e98dc1b9c17bdc171e67b416d884cc.png width=1272 height=570 class=img_m1Wr /></p>
|
|
6
6
|
<p>Note the config and logs buckets are organized by scopes of which there initially is just one: DEFAULT. Clicking the DEFAULT folder in the logs bucket shows the decom_logs, raw_logs, reduced_xxx_logs, text_logs and tool_logs.</p>
|
|
7
|
-
<h3 class="anchor
|
|
7
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=decom_logs--raw_logs>decom_logs & raw_logs<a href=#decom_logs--raw_logs class=hash-link aria-label="Direct link to decom_logs & raw_logs" title="Direct link to decom_logs & raw_logs" translate=no></a></h3>
|
|
8
8
|
<p>The decom_logs and raw_logs folders contain the decommutated and raw command and telemetry data. Both are further broken down by target, packet, then date. For example, browsing into the DEFAULT/raw_logs/tlm/INST2/<YYYYMMDD>/ directory:</p>
|
|
9
|
-
<p><img decoding=async loading=lazy alt=raw_tlm_logs src=/tools/staticdocs/assets/images/raw_tlm_logs-b293435cebbd5d4f04ab8a469ce2b4eb66f4cfd046d7b18ee417893336816b85.png width=1272 height=557 class=
|
|
9
|
+
<p><img decoding=async loading=lazy alt=raw_tlm_logs src=/tools/staticdocs/assets/images/raw_tlm_logs-b293435cebbd5d4f04ab8a469ce2b4eb66f4cfd046d7b18ee417893336816b85.png width=1272 height=557 class=img_m1Wr /></p>
|
|
10
10
|
<p>Note the presence of the gzipped .bin files which contain the raw binary data. For more information about the structure of these files see the <a href=/tools/staticdocs/docs/development/log-structure>Log Structure</a> developer documentation.</p>
|
|
11
11
|
<p>The default settings for the Logging microservice is to start a new log file every 10 minutes or 50MB, which ever comes first. In the case of the low data rate demo, the 10 minute mark is hit first.</p>
|
|
12
12
|
<p>To change the logging settings add the various CYCLE_TIME <a href=/tools/staticdocs/docs/configuration/plugins#target-modifiers>Target Modifiers</a> under the declared <a href=/tools/staticdocs/docs/configuration/plugins#target-1>TARGET</a> name in your plugin.txt.</p>
|
|
13
|
-
<h3 class="anchor
|
|
13
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=text_logs>text_logs<a href=#text_logs class=hash-link aria-label="Direct link to text_logs" title="Direct link to text_logs" translate=no></a></h3>
|
|
14
14
|
<p>The text_logs folder contains openc3_log_messages which contains text files that are again sorted by date and timestamped. These log messages come from the various microservices including the server and the target microservices. Thus these logs contain all the commands sent (in plain text) and telemetry checked. These log messages files are long term records of the messages in the CmdTlmServer Log Messages window:</p>
|
|
15
|
-
<p><img decoding=async loading=lazy alt=log_messages src=/tools/staticdocs/assets/images/log_messages-6dd20c27f64fc00c8e61ee1062193fd6cb31efa4701130385c9853abfeed8495.png width=1266 height=469 class=
|
|
16
|
-
<h3 class="anchor
|
|
15
|
+
<p><img decoding=async loading=lazy alt=log_messages src=/tools/staticdocs/assets/images/log_messages-6dd20c27f64fc00c8e61ee1062193fd6cb31efa4701130385c9853abfeed8495.png width=1266 height=469 class=img_m1Wr /></p>
|
|
16
|
+
<h3 class="anchor anchorWithStickyNavbar_TUrh" id=tool_logs>tool_logs<a href=#tool_logs class=hash-link aria-label="Direct link to tool_logs" title="Direct link to tool_logs" translate=no></a></h3>
|
|
17
17
|
<p>The tool_logs directory contains logs from the various COSMOS tools. Note that if you have not yet run any tools you may not see this directory as it is created on demand. Tool sub-directories are also created on demand. For example, after running a script in Script Runner a new 'sr' subdirectory appears which contains the script runner log resulting from running the script. In some cases logs in this directory may also be directly available from the tool itself. In the Script Runner case, the Script Messages pane below the script holds the output messages from the last script. Clicking the Download link allows you to download these messages as a file.</p>
|
|
18
|
-
<p><img decoding=async loading=lazy alt=log_messages src=/tools/staticdocs/assets/images/script_messages-5c30dab8202ae3d18fa1f12cdd43f409967b1d4ac84a4a0e96bf027041ab9a07.png width=1266 height=599 class=
|
|
18
|
+
<p><img decoding=async loading=lazy alt=log_messages src=/tools/staticdocs/assets/images/script_messages-5c30dab8202ae3d18fa1f12cdd43f409967b1d4ac84a4a0e96bf027041ab9a07.png width=1266 height=599 class=img_m1Wr /></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/logging.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_CuGa aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_h4bd"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/guides/local-mode><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Local Mode</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/guides/monitoring><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Monitoring</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_rhgf thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#decom_logs--raw_logs class="table-of-contents__link toc-highlight">decom_logs & raw_logs</a><li><a href=#text_logs class="table-of-contents__link toc-highlight">text_logs</a><li><a href=#tool_logs class="table-of-contents__link toc-highlight">tool_logs</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
|