openc3-cosmos-tool-docs 5.20.0 → 6.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +1 -13
- data/tools/staticdocs/assets/css/styles.839a3ee9.css +1 -0
- data/tools/staticdocs/assets/images/add_tool-6919be6e6c05db133a8816a9fc03bf98b0789a8525da4cdaa7b041b25bf9edb8.png +0 -0
- data/tools/staticdocs/assets/images/array-c0c541246cb3f9e355acc5c510649c29116ce4d6eb8864b9ace48e9958b36421.png +0 -0
- data/tools/staticdocs/assets/images/backcolor-39ca0e2a25bd98fe1c9e067f026f3a719a760d3f14ccb404e2da3a0af4235760.png +0 -0
- data/tools/staticdocs/assets/images/block-14583c7d26c1a1c6553435d57015bc5282426f7aa176804867de223009a8d4d7.png +0 -0
- data/tools/staticdocs/assets/images/bordercolor-a3ac15f24f91c910fcc9c8bd195232205ec44da0b428b11b71108687ce6316d3.png +0 -0
- data/tools/staticdocs/assets/images/button-3f6fd69518f4b2c60b15605ca607cda8b596d4d5e804b867f09f750a47b6cbad.png +0 -0
- data/tools/staticdocs/assets/images/canvasdot-d634bed1905d13b0da41200e62781cea6e012b5d68fc914f4c11f512c9c4f7fd.png +0 -0
- data/tools/staticdocs/assets/images/canvasimage-6f6f83dc6d777fdff0b820287a96ad171a475fda2896c0a3b678b14984e496fd.png +0 -0
- data/tools/staticdocs/assets/images/canvasimagevalue-8c835310f99cebbb15ad34632c77370cf4cc9b95535040fa4723df8baedb5b57.png +0 -0
- data/tools/staticdocs/assets/images/canvaslabel-68ee99da9ef15924a2b5b41c60ba7de47382d036eece57574411839ff5ec14e4.png +0 -0
- data/tools/staticdocs/assets/images/canvaslabelvalue-43254b6647e626939e79ec7e0940e921582039af006e5024c952881ba196b165.png +0 -0
- data/tools/staticdocs/assets/images/canvasline-c5120da84530d4a60a04d40d5565daede656639808d1a456f430e9404a2d5bad.png +0 -0
- data/tools/staticdocs/assets/images/canvaslinevalue-5540d10997f723fd09b269b75997452622a3c4333ed4f25628747c1212699255.png +0 -0
- data/tools/staticdocs/assets/images/checkbutton-c263b840dcdbeca5cd886884fe8f24bedac7daac5a0ca224a1fb2cce3e24bdf6.png +0 -0
- data/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
- data/tools/staticdocs/assets/images/collect_states-5418d5b4cb901577f2cbdeccceb254dd2e5b81b1f2c975fb15b5fc679cf23dbf.png +0 -0
- data/tools/staticdocs/assets/images/combobox-6c8fa241aa7c5ccf31a42a2373dbd4f6f66d9a063e98ba111d5472b5c8e21590.png +0 -0
- data/tools/staticdocs/assets/images/command_history-ecc9b618661ad0aefa0700047a8ab3b094372f2aa427e9fcd270dcd352a30408.png +0 -0
- data/tools/staticdocs/assets/images/command_sender-83cf2e2343133c2883c405abd0b322f6d3d4a095c6ee800158a04c8eefe474ed.png +0 -0
- data/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png +0 -0
- data/tools/staticdocs/assets/images/date-d104f822ef7a1b99ade0a334e2e34c27fc6b1d087ed267f13280623a943113ce.png +0 -0
- data/tools/staticdocs/assets/images/formatvalue-8e2ddb6cec177fde1846d333d70168479a3bf67dd2b293764f938726b9e7cdf8.png +0 -0
- data/tools/staticdocs/assets/images/height-67268e562da2f9b2d0b9adc38d8fb2ba629504b09d798d8c26be9cfbfdad672a.png +0 -0
- data/tools/staticdocs/assets/images/history-04aebef1a0fdaaacc5042e5b835f850b48ea04f4fe50271d9bb57803b442d6cd.png +0 -0
- data/tools/staticdocs/assets/images/horizontal-11de51b6fc8baf057ca4f38a7f54a5302b58f30099331c22a074f012e53497aa.png +0 -0
- data/tools/staticdocs/assets/images/horizontalbox-ddf82f64de700286a742a71e0c1adebbc7e9822a0dff41139f41bc476e4fc4ce.png +0 -0
- data/tools/staticdocs/assets/images/horizontalline-0805762eadcc125ed6584a29a60e7cf8e2d76d13c6243e18eecbaba7a3803128.png +0 -0
- data/tools/staticdocs/assets/images/iframe-30d5a4104336b84d18ba538d668978a7986679431a7fe1fd0e3179fea08c074f.png +0 -0
- data/tools/staticdocs/assets/images/imageviewer-6149159e29a35cd6694926b344836ce034ce17cc019537028a80d95460eec405.png +0 -0
- data/tools/staticdocs/assets/images/inst_clear-48f37464d774363be4a5c1d30a48d4bc7803cb806a15d80dcd3741d7a9a37811.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect-ef36e8a1e97fde625cde7a9c300c3db61aca30140f5431f089ce6a3e5da9d7f4.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous-02857bda2b5e7e821d3f42d3301962ede2bb4379c469a9d62f4a0e686336f0c4.png +0 -0
- data/tools/staticdocs/assets/images/interfaces-fa10646a27eb9045b70c2c485498a864bed1896ff171b7f31f8698288e08ae73.png +0 -0
- data/tools/staticdocs/assets/images/label-25a3052a497d0db7ebf84c788baedcd01d34f4b423aceee53d6d83639a128e82.png +0 -0
- data/tools/staticdocs/assets/images/labelled-b8d0f0a157f48e1fa98511f9177f962e69d1e0e8c24b37cf9f355671f9d13ab8.png +0 -0
- data/tools/staticdocs/assets/images/labelprogressbar-c3412db92b2f4e6af20233b085ee20915414d6c4da371398a3e8f36b84971cc7.png +0 -0
- data/tools/staticdocs/assets/images/labelsparkline-5985a0f034a5d2fb54b040612178ac9f0d5476eb76ca7e04cacc2618a9970c69.png +0 -0
- data/tools/staticdocs/assets/images/labelvalue-db97724272df4815b4ecc397974f91a62c31108b98ef0657716c670ca8128051.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluedesc-2e174a9f3443ba971683dea9a33f8aa66d0248fb92a3aff41ec26b7424b5e68c.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluelimitscolumn-47664affa9d88150ce257e90d32c61b314d7f0b6aa6da4f5e49152be2cce4ef7.png +0 -0
- data/tools/staticdocs/assets/images/labelvaluerangebar-641eba160b8ef7872557584de92f046d9e4411fae3280781f9b049265cc6dd52.png +0 -0
- data/tools/staticdocs/assets/images/led-d333a6c7e8b1bad13b7775142c74f94b1829ddedd38814d606b2d00e76707751.png +0 -0
- data/tools/staticdocs/assets/images/limitsbar-4f2758f846f6f8a1add81aeaf3b58e071792a6d2ccae9eb504e9c07ab8f8dae1.png +0 -0
- data/tools/staticdocs/assets/images/limitscolor-7f8e24e4f27f476c3b4c57393ab797268b86aa8ad8b6e7b83d72dd5bf3ca7952.png +0 -0
- data/tools/staticdocs/assets/images/limitscolumn-743800180e9558c86a4f5c5d949e2b8355420a98c85ef98a3320b09defa21fe6.png +0 -0
- data/tools/staticdocs/assets/images/linegraph-dc3cca59601beb3ea551bbd05e4e09b6cfabd1a7cbc93b757a7d4b22c478a75b.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-6da2901ac63928daa3dcaf39a78ca9e455482c48d4ba917ee704f697e5210818.png +0 -0
- data/tools/staticdocs/assets/images/margin-4247b51c2c305cb961d08a807f30883b7fc6d9e3316c18174b86afe2356106dd.png +0 -0
- data/tools/staticdocs/assets/images/matrixbycolumns-74a67f236a97fffbdf7251fc98da2302a92df20ad16793a1617bc6f77380c9f6.png +0 -0
- data/tools/staticdocs/assets/images/microservices-805cc7d137958ac8183579cdb9a9845e7aef79db19723f0773f4ea4d957b48a1.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-04b9187b57a09ed12481a2699a86c7504fdc1c822579b4f762865ea90cb52dd3.png +0 -0
- data/tools/staticdocs/assets/images/named_widget-37362db8e310e5639be849d729fd637677f72330d676da4cd6baafc4b961331c.png +0 -0
- data/tools/staticdocs/assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png +0 -0
- data/tools/staticdocs/assets/images/padding-e8ceea8ec79def3b14d186971854c44883675d974409366b77c586eedd85025c.png +0 -0
- data/tools/staticdocs/assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png +0 -0
- data/tools/staticdocs/assets/images/progressbar-cc1095369de0d483c4a9b07ad3a76f9e966990b2aa68b2bc8177d7130ed382a7.png +0 -0
- data/tools/staticdocs/assets/images/radiobutton-9151f7cb0dae5120e51e05b5575981c143e19f350e84c7e190d3dd78aa80fae8.png +0 -0
- data/tools/staticdocs/assets/images/rangebar-ceae5a30609ab12625e29fd479e88fb3ba16eb12879976edc807da87547a275d.png +0 -0
- data/tools/staticdocs/assets/images/raw-63c1dd793f4a734e7d512bf4c0c3722831c38d5392a1a1b0cb77bbef4d16b96b.png +0 -0
- data/tools/staticdocs/assets/images/redis-4553b5b35292cca3df1fa08577f2175efef34e0fdfe512f30ca70785b086b24f.png +0 -0
- data/tools/staticdocs/assets/images/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png +0 -0
- data/tools/staticdocs/assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png +0 -0
- data/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png +0 -0
- data/tools/staticdocs/assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png +0 -0
- data/tools/staticdocs/assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png +0 -0
- data/tools/staticdocs/assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png +0 -0
- data/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png +0 -0
- data/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png +0 -0
- data/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png +0 -0
- data/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png +0 -0
- data/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png +0 -0
- data/tools/staticdocs/assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png +0 -0
- data/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png +0 -0
- data/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png +0 -0
- data/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png +0 -0
- data/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png +0 -0
- data/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png +0 -0
- data/tools/staticdocs/assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png +0 -0
- data/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png +0 -0
- data/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png +0 -0
- data/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png +0 -0
- data/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png +0 -0
- data/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png +0 -0
- data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
- data/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.8413befc.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.a4ceeb8e.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ae0a89e8.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.90ef4019.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.1c827de2.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.3b7f9c95.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.76716a45.js +1 -0
- data/tools/staticdocs/assets/js/13196248.18801ae0.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.4457fa9a.js +1 -0
- data/tools/staticdocs/assets/js/1602.1e622848.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.8e63f255.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.9470f5c9.js +1 -0
- data/tools/staticdocs/assets/js/2124.0e1f26f5.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.ac895789.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.45d268b1.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.471e10a1.js +1 -0
- data/tools/staticdocs/assets/js/3040.18a0bb2a.js +4 -0
- data/tools/staticdocs/assets/js/3687.6fa52db1.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.d8bb37a8.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.5f8a5da7.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.c8f67fde.js +1 -0
- data/tools/staticdocs/assets/js/42170351.86617d4a.js +1 -0
- data/tools/staticdocs/assets/js/4303.a84f454a.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.0c473c25.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.f0e35da3.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.9ace531c.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.565c0c28.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.80b7b43c.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.ed839e0d.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.048e258b.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.96109971.js +1 -0
- data/tools/staticdocs/assets/js/62df909c.dd5f3a0c.js +1 -0
- data/tools/staticdocs/assets/js/630e5448.699a9dec.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.4008a669.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.34aa1d77.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.d37e3087.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.f71c0e94.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.c98e31e0.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.1053fbd7.js +1 -0
- data/tools/staticdocs/assets/js/75897369.522ccdd7.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.45bf7edc.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7f5b2696.72e3b019.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.5a408d9c.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.866fe67b.js +1 -0
- data/tools/staticdocs/assets/js/89e76475.b4e9da15.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.59da8025.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.cc8aa06e.js +1 -0
- data/tools/staticdocs/assets/js/97535711.94a5b402.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.ebea1d08.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.4bc52207.js +1 -0
- data/tools/staticdocs/assets/js/{9fb6059a.a5107afb.js → 9fb6059a.57936fbe.js} +1 -1
- data/tools/staticdocs/assets/js/a677c089.d8d7a8f5.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.2aa836fd.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.993f091d.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.a5fe2cea.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.5df56282.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.cdb4a698.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.5fb449fc.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.f419c8fb.js +1 -0
- data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +1 -0
- data/tools/staticdocs/assets/js/c5388ca4.32f8f561.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.9264e5dd.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.aa3c877c.js +1 -0
- data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.de9e8fd6.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.82dd17ab.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.1cb515f4.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.09769a64.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1704d750.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.1861d710.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js +1 -0
- data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js +1 -0
- data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.fa25adc4.js +1 -0
- data/tools/staticdocs/assets/js/main.c4acbd62.js +36 -0
- data/tools/staticdocs/assets/js/runtime~main.cb6ff8de.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +85 -0
- data/tools/staticdocs/docs/configuration/command.html +148 -160
- data/tools/staticdocs/docs/configuration/format.html +28 -40
- data/tools/staticdocs/docs/configuration/interfaces.html +119 -64
- data/tools/staticdocs/docs/configuration/plugins.html +234 -225
- data/tools/staticdocs/docs/configuration/protocols.html +106 -92
- data/tools/staticdocs/docs/configuration/ssl-tls.html +34 -46
- data/tools/staticdocs/docs/configuration/table.html +88 -100
- data/tools/staticdocs/docs/configuration/target.html +29 -41
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +368 -322
- data/tools/staticdocs/docs/configuration/telemetry.html +136 -142
- data/tools/staticdocs/docs/configuration.html +1 -13
- data/tools/staticdocs/docs/development/curl.html +17 -29
- data/tools/staticdocs/docs/development/developing.html +24 -36
- data/tools/staticdocs/docs/development/json-api.html +26 -38
- data/tools/staticdocs/docs/development/log-structure.html +19 -31
- data/tools/staticdocs/docs/development/roadmap.html +26 -44
- data/tools/staticdocs/docs/development/streaming-api.html +10 -22
- data/tools/staticdocs/docs/development/testing.html +23 -27
- data/tools/staticdocs/docs/development.html +1 -13
- data/tools/staticdocs/docs/getting-started/generators.html +37 -49
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +45 -56
- data/tools/staticdocs/docs/getting-started/installation.html +24 -36
- data/tools/staticdocs/docs/getting-started/key_concepts.html +32 -44
- data/tools/staticdocs/docs/getting-started/podman.html +25 -37
- data/tools/staticdocs/docs/getting-started/requirements.html +32 -44
- data/tools/staticdocs/docs/getting-started/upgrading.html +135 -24
- data/tools/staticdocs/docs/getting-started.html +1 -13
- data/tools/staticdocs/docs/guides/bridges.html +17 -30
- data/tools/staticdocs/docs/guides/cfs.html +46 -58
- data/tools/staticdocs/docs/guides/custom-widgets.html +17 -29
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -15
- data/tools/staticdocs/docs/guides/local-mode.html +16 -28
- data/tools/staticdocs/docs/guides/logging.html +12 -24
- data/tools/staticdocs/docs/guides/monitoring.html +18 -30
- data/tools/staticdocs/docs/guides/performance.html +21 -33
- data/tools/staticdocs/docs/guides/raspberrypi.html +16 -28
- data/tools/staticdocs/docs/guides/script-writing.html +108 -120
- data/tools/staticdocs/docs/guides/scripting-api.html +606 -615
- data/tools/staticdocs/docs/guides.html +1 -13
- data/tools/staticdocs/docs/meta/contributing.html +14 -26
- data/tools/staticdocs/docs/meta/licenses.html +36 -25
- data/tools/staticdocs/docs/meta/philosophy.html +3 -15
- data/tools/staticdocs/docs/meta/xtce.html +13 -25
- data/tools/staticdocs/docs/meta.html +1 -13
- data/tools/staticdocs/docs/privacy.html +19 -31
- data/tools/staticdocs/docs/tools/admin.html +36 -0
- data/tools/staticdocs/docs/tools/autonomic.html +22 -34
- data/tools/staticdocs/docs/tools/bucket-explorer.html +10 -22
- data/tools/staticdocs/docs/tools/calendar.html +21 -33
- data/tools/staticdocs/docs/tools/cmd-sender.html +16 -28
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +27 -36
- data/tools/staticdocs/docs/tools/command_history.html +10 -0
- data/tools/staticdocs/docs/tools/data-extractor.html +29 -41
- data/tools/staticdocs/docs/tools/data-viewer.html +11 -23
- data/tools/staticdocs/docs/tools/handbooks.html +4 -16
- data/tools/staticdocs/docs/tools/limits-monitor.html +18 -30
- data/tools/staticdocs/docs/tools/packet-viewer.html +16 -28
- data/tools/staticdocs/docs/tools/script-runner.html +43 -55
- data/tools/staticdocs/docs/tools/table-manager.html +16 -28
- data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -33
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -28
- data/tools/staticdocs/docs/tools.html +1 -13
- data/tools/staticdocs/docs.html +12 -24
- data/tools/staticdocs/img/admin/add_tool.png +0 -0
- data/tools/staticdocs/img/admin/interfaces.png +0 -0
- data/tools/staticdocs/img/admin/microservices.png +0 -0
- data/tools/staticdocs/img/admin/packages.png +0 -0
- data/tools/staticdocs/img/admin/plugins.png +0 -0
- data/tools/staticdocs/img/admin/redis.png +0 -0
- data/tools/staticdocs/img/admin/routers.png +0 -0
- data/tools/staticdocs/img/admin/secrets.png +0 -0
- data/tools/staticdocs/img/admin/settings1.png +0 -0
- data/tools/staticdocs/img/admin/settings2.png +0 -0
- data/tools/staticdocs/img/admin/targets.png +0 -0
- data/tools/staticdocs/img/admin/tools.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_authority.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/critical_cmd_sender.png +0 -0
- data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
- data/tools/staticdocs/img/command_history/command_history.png +0 -0
- data/tools/staticdocs/img/command_sender/collect_states.png +0 -0
- data/tools/staticdocs/img/command_sender/command_sender.png +0 -0
- data/tools/staticdocs/img/command_sender/history.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_clear.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_collect.png +0 -0
- data/tools/staticdocs/img/command_sender/inst_collect_hazardous.png +0 -0
- data/tools/staticdocs/img/command_sender/mode_menu.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/array.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/backcolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/block.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/bordercolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/button.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasdot.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimage.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimagevalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabel.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabelvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvasline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslinevalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/checkbutton.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/combobox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/date.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/formatvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/height.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontal.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/iframe.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/imageviewer.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/label.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelled.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelprogressbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelsparkline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvalue.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluedesc.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluelimitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluerangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/led.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitsbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/linegraph.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/margin.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/matrixbycolumns.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/named_widget.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/padding.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/progressbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/radiobutton.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/rangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/raw.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/rollup.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/scrollwindow.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/signal.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/spacer.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/sparkline.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/subsetting.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/tabbook.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/tabitem.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textcolor.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/textfield.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/time.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/title.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/value.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitsbar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitscolumn.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/valuerangebar.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/vertical.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
- data/tools/staticdocs/img/telemetry_viewer/widgets/width.png +0 -0
- data/tools/staticdocs/index.html +1 -13
- data/tools/staticdocs/lunr-index-1734734383200.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +2 -14
- data/tools/staticdocs/search-doc-1734734383200.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +254 -99
- data/tools/staticdocs/assets/css/styles.80ddca08.css +0 -1
- data/tools/staticdocs/assets/images/cmd_authority-51594401bfa6d8cc5849aae05b4d2af838360f8a3329f9746aa1307fe3091402.png +0 -0
- data/tools/staticdocs/assets/images/cmd_tlm_server-727ea478568988b10e4be4a3ba7255dd48ec56f6ab6444c6c1e32497fe478681.png +0 -0
- data/tools/staticdocs/assets/images/collect_states-565ae4b6d02449850585afd7ce35982711d4d677f5a04c1332b2c176f1ec3a25.png +0 -0
- data/tools/staticdocs/assets/images/command_sender-bb1543bde21fc1963405de5251d16a80a0c3a1bf5adb5fb78145d4995e2fe541.png +0 -0
- data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
- data/tools/staticdocs/assets/images/inst_clear-2d5f985c879e8b917fedacdb8c6552bbd383231bf5c8ab8e560e77df4e050026.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect-81bc422b3b33c5ebcbe4c2f489c730b32ab0d6ea6c7f81cc79d9f6bc03e9db15.png +0 -0
- data/tools/staticdocs/assets/images/inst_collect_hazardous-a8fb19ea296354a0cd276da1e0ad82f74479eea4e7e204fcf64b779596f2c092.png +0 -0
- data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
- data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.727d87f1.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.f2d69d72.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.83641127.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.017a0733.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.aa4daee5.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.537144c5.js +0 -1
- data/tools/staticdocs/assets/js/13196248.6b49e93d.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.22a0b1d4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.0445f325.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.25d11993.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +0 -1
- data/tools/staticdocs/assets/js/2601.ca992ab9.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.633f7a6c.js +0 -1
- data/tools/staticdocs/assets/js/3917.a6366d59.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.d55880a8.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.4b4b2ccd.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.1d6a609d.js +0 -1
- data/tools/staticdocs/assets/js/42170351.d7f6034b.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.fa34b0b0.js +0 -1
- data/tools/staticdocs/assets/js/5723.f6123e37.js +0 -1
- data/tools/staticdocs/assets/js/5778.7d36f1c2.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.6fdd6b6c.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.daa2a049.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.61a9cae2.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.0b54b37a.js +0 -1
- data/tools/staticdocs/assets/js/62df909c.906d9999.js +0 -1
- data/tools/staticdocs/assets/js/630e5448.6fea087c.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.60c3c6d5.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.a5ae3d65.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.aaa91da1.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.76b83e83.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.d02304f0.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.98821dd1.js +0 -1
- data/tools/staticdocs/assets/js/75897369.7b31b03e.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.6ef0928b.js +0 -1
- data/tools/staticdocs/assets/js/7760.7f593c4f.js +0 -2
- data/tools/staticdocs/assets/js/7760.7f593c4f.js.LICENSE.txt +0 -61
- data/tools/staticdocs/assets/js/7f5b2696.60735273.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.48133ad5.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.13ce283b.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.7a68246a.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.b6a7e150.js +0 -1
- data/tools/staticdocs/assets/js/97535711.5311ddd9.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.64e9c551.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +0 -1
- data/tools/staticdocs/assets/js/a507c363.d2cc5d72.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.7877e85d.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.0358fb0b.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.9f3252e1.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.daa24b72.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.19c327f0.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.6691ccc4.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.503774e8.js +0 -1
- data/tools/staticdocs/assets/js/c2598f55.c5a1bac3.js +0 -1
- data/tools/staticdocs/assets/js/c5388ca4.f526bb0c.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.b82ad06f.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.f956406f.js +0 -1
- data/tools/staticdocs/assets/js/ce89ef36.aa518a52.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.28d99aa4.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.6c422113.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.8f23a506.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.fb296e02.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.2349d796.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.8f82360d.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.b0500934.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.e3a82d1e.js +0 -1
- data/tools/staticdocs/assets/js/dfbae5fd.d1484e14.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.0b407477.js +0 -1
- data/tools/staticdocs/assets/js/ebec1ccb.a1b5fc97.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.ee14b7d6.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.4a41fa80.js +0 -1
- data/tools/staticdocs/assets/js/main.03e795fe.js +0 -2
- data/tools/staticdocs/assets/js/main.03e795fe.js.LICENSE.txt +0 -71
- data/tools/staticdocs/assets/js/runtime~main.cb8e940d.js +0 -1
- data/tools/staticdocs/docs/development/host-install.html +0 -38
- data/tools/staticdocs/docs/v5/host-install/index.html +0 -11
- data/tools/staticdocs/lunr-index-1730331075297.json +0 -1
- data/tools/staticdocs/search-doc-1730331075297.json +0 -1
@@ -1,47 +1,158 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<
|
3
|
-
<
|
4
|
-
<meta charset="UTF-8">
|
5
|
-
<meta name="generator" content="Docusaurus v3.5.2">
|
6
|
-
<title data-rh="true">Upgrading | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading"><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="Upgrading | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS Upgrades"><meta data-rh="true" property="og:description" content="COSMOS Upgrades"><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/getting-started/upgrading"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.cb8e940d.js" defer="defer"></script>
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.03e795fe.js" defer="defer"></script>
|
9
|
-
</head>
|
10
|
-
<body class="navigation-with-keyboard">
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Upgrading</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Upgrading</h1></header><h3 class="anchor anchorWithStickyNavbar_fF9Z" id="cosmos-upgrades">COSMOS Upgrades<a href="#cosmos-upgrades" class="hash-link" aria-label="Direct link to COSMOS Upgrades" title="Direct link to COSMOS Upgrades"></a></h3>
|
12
|
-
<p>COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release.</p>
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/upgrading" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Upgrading | 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/getting-started/upgrading><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="Upgrading | OpenC3 Docs"><meta data-rh=true name=description content="How to upgrade and migrate COSMOS"><meta data-rh=true property=og:description content="How to upgrade and migrate 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/getting-started/upgrading><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.cb6ff8de.js defer></script><script src=/tools/staticdocs/assets/js/main.c4acbd62.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation>Installation</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/getting-started/gettingstarted>Getting Started</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/getting-started/generators>Code Generators</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/getting-started/upgrading>Upgrading</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/getting-started/key_concepts>Key Concepts</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/getting-started/requirements>Requirements and Design</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/getting-started/podman>Podman</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/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 menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/getting-started><span itemprop=name>Getting Started</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Upgrading</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Upgrading</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=cosmos-upgrades>COSMOS Upgrades<a href=#cosmos-upgrades class=hash-link aria-label="Direct link to COSMOS Upgrades" title="Direct link to COSMOS Upgrades"></a></h2>
|
2
|
+
<p>COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release.</p>
|
3
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Release Notes</div><div class=admonitionContent_bl22><p>Always check the release notes associated with the release on the <a href=https://github.com/OpenC3/cosmos/releases target=_blank rel="noopener noreferrer">releases</a> page. Sometimes there are migration notes.</div></div>
|
13
4
|
<p>This example assumes an existing COSMOS project at C:\cosmos-project.</p>
|
14
5
|
<ol>
|
15
6
|
<li>
|
16
7
|
<p>Stop the current COSMOS application</p>
|
17
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style
|
8
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\cosmos-project> openc3.bat stop</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
18
9
|
</li>
|
19
10
|
<li>
|
20
11
|
<p>Change the release in the .env file to the desired release</p>
|
21
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style
|
12
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">OPENC3_TAG=5.1.1</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
22
13
|
</li>
|
23
14
|
<li>
|
24
15
|
<p>Run the new COSMOS application</p>
|
25
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style
|
16
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\cosmos-project> openc3.bat run</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
26
17
|
</li>
|
27
18
|
</ol>
|
28
|
-
<
|
29
|
-
<
|
19
|
+
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>Downgrades</div><div class=admonitionContent_bl22><p>Downgrades are not necessarily supported. When upgrading COSMOS we need to upgrade databases and sometimes migrate internal data structures. While we perform a full regression test on every release, we recommend upgrading an individual machine with your specific plugins and do local testing before rolling out the upgrade to your production system.<p>In general, patch releases (x.y.Z) can be downgraded, minor releases (x.Y.z) <em>might</em> be able to be downgraded and major releases (X.y.z) are NOT able to be downgraded.</div></div>
|
20
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=migrating-from-cosmos-5-to-cosmos-6>Migrating From COSMOS 5 to COSMOS 6<a href=#migrating-from-cosmos-5-to-cosmos-6 class=hash-link aria-label="Direct link to Migrating From COSMOS 5 to COSMOS 6" title="Direct link to Migrating From COSMOS 5 to COSMOS 6"></a></h2>
|
21
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Developers Only</div><div class=admonitionContent_bl22><p>If you haven't written any custom tools or widgets, there are no special changes required to upgrade from COSMOS 5 to COSMOS 6. Simply follow the normal upgrade instructions above including following the release notes.</div></div>
|
22
|
+
<p>COSMOS 6 introduces some breaking changes for custom tools regarding the Vue framework and our common library code. We've upgraded from Vue 2 (EOL December 31, 2023) to Vue 3. These versions of Vue are not compatible with each other, so any tools written with Vue 2 will need to be updated. Additionally, our <code>@openc3/tool-common</code> NPM package has been deprecated with its functionality reorganized into two packages: <code>@openc3/js-common</code> and <code>@openc3/vue-common</code>. This is to provide a better experience for developers who are building COSMOS tools without the Vue framework.</p>
|
23
|
+
<p>We also removed a few rarely used <a href=/tools/staticdocs/docs/guides/scripting-api#migration-from-cosmos-v5-to-v6>API methods</a> in COSMOS 6.</p>
|
24
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=updating-vue>Updating Vue<a href=#updating-vue class=hash-link aria-label="Direct link to Updating Vue" title="Direct link to Updating Vue"></a></h3>
|
25
|
+
<p><em>If your tool was not built with Vue (e.g. it was built without a frontend framework, or it was built with React, Angular, etc.), then you can skip this section.</em></p>
|
26
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=the-quick-and-dirty-way>The quick and dirty way<a href=#the-quick-and-dirty-way class=hash-link aria-label="Direct link to The quick and dirty way" title="Direct link to The quick and dirty way"></a></h4>
|
27
|
+
<p>Tools that are relatively simple can probably be upgraded in one shot by just updating the dependencies and fixing any build errors that arise, and then fixing any runtime errors you find from testing and using your tool. If you're confident in this upgrade path, you can reference <a href=https://github.com/OpenC3/cosmos/pull/1747 target=_blank rel="noopener noreferrer">this pull request</a> to see what will need to change. Otherwise, the rest of this guide will walk you through a more in-depth and complete migration process.</p>
|
28
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-1-vue-compat-mode>Step 1: Vue compat mode<a href=#step-1-vue-compat-mode class=hash-link aria-label="Direct link to Step 1: Vue compat mode" title="Direct link to Step 1: Vue compat mode"></a></h4>
|
29
|
+
<p>The Vue team provided a compatibility mode to help with migrating from Vue 2 to Vue 3. This will let you get your tool up and running to make it easier to find the necessary changes.</p>
|
30
|
+
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1a-update-dependencies>(1.a) Update dependencies<a href=#1a-update-dependencies class=hash-link aria-label="Direct link to (1.a) Update dependencies" title="Direct link to (1.a) Update dependencies"></a></h5>
|
31
|
+
<p>Use your package manager or edit the package.json file to update the following dependencies (ignore any packages marked "Update" that you aren't using)</p>
|
32
|
+
<ul>
|
33
|
+
<li><strong>Remove:</strong> <code>vue-template-compiler</code></li>
|
34
|
+
<li><strong>Add:</strong> <code>@vue/compat</code> >= 3.5 (<a href=https://www.npmjs.com/package/@vue/compat target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
35
|
+
<li><strong>Add:</strong> <code>@vue/compiler-sfc</code> >= 3.5 (<a href=https://www.npmjs.com/package/@vue/compiler-sfc target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
36
|
+
<li><strong>Update:</strong> <code>@vue/test-utils</code> >= 2.4 (<a href=https://www.npmjs.com/package/@vue/compiler-sfc target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
37
|
+
<li><strong>Update:</strong> <code>vue</code> >= 3.5 (<a href=https://www.npmjs.com/package/vue target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
38
|
+
<li><strong>Update:</strong> <code>vuex</code> >= 4.1 (<a href=https://www.npmjs.com/package/vuex target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
39
|
+
<li><strong>Update:</strong> <code>vue-router</code> >= 4.4 (<a href=https://www.npmjs.com/package/vue-router target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
40
|
+
<li><strong>Update:</strong> <code>vuetify</code> >= 3.7 (<a href=https://www.npmjs.com/package/vuetify target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
41
|
+
<li><strong>Update:</strong> <code>single-spa-vue</code> >= 3.0 (<a href=https://www.npmjs.com/package/single-spa-vue target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
42
|
+
</ul>
|
43
|
+
<p>Eslint will help call out changes you'll need to make to your code for the migration, so it's recommended to include eslint in your project if you haven't already. There are plenty of guides online that will explain how to do that. If you're using eslint, then make the additional changes to your tool's dependencies:</p>
|
44
|
+
<ul>
|
45
|
+
<li><strong>Add:</strong> <code>eslint-plugin-vuetify</code> >= 2.5 (<a href=https://www.npmjs.com/package/eslint-plugin-vuetify target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
46
|
+
<li><strong>Add:</strong> <code>vue-eslint-parser</code> >= 9.4 (<a href=https://www.npmjs.com/package/vue-eslint-parser target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
47
|
+
</ul>
|
48
|
+
<p>If you modified your package.json file manually, don't forget to <code>yarn</code> or <code>npm install</code> at your project's root to apply the changes.</p>
|
49
|
+
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1b-update-the-vue-config-file-vueconfigjs>(1.b) Update the Vue config file (<code>vue.config.js</code>)<a href=#1b-update-the-vue-config-file-vueconfigjs class=hash-link aria-label="Direct link to 1b-update-the-vue-config-file-vueconfigjs" title="Direct link to 1b-update-the-vue-config-file-vueconfigjs"></a></h5>
|
50
|
+
<p>You likely have a <code>chainWebpack</code> property in the object that's exported by this file which looks something like this (though your contents might vary)</p>
|
51
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function-variable function" style="color:rgb(130, 170, 255)">chainWebpack</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">module</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 method function property-access" style="color:rgb(130, 170, 255)">rule</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</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 method function property-access" style="color:rgb(130, 170, 255)">use</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue-loader'</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 method function property-access" style="color:rgb(130, 170, 255)">tap</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword control-flow" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">prettify</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</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"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
52
|
+
<p>Add a resolution alias for <code>@vue/compat</code> to the top of this block and set the compiler to use the Vue 2 compat mode:</p>
|
53
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function-variable function" style="color:rgb(130, 170, 255)">chainWebpack</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">resolve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">alias</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">set</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'@vue/compat'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">module</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 method function property-access" style="color:rgb(130, 170, 255)">rule</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</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 method function property-access" style="color:rgb(130, 170, 255)">use</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue-loader'</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 method function property-access" style="color:rgb(130, 170, 255)">tap</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword control-flow" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">prettify</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</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 literal-property property" style="color:rgb(128, 203, 196)">compilerOptions</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this block</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">compatConfig</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// to here</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"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
54
|
+
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1c-update-the-eslint-config-file-eslintrc>(1.c) Update the eslint config file (<code>.eslintrc</code>)<a href=#1c-update-the-eslint-config-file-eslintrc class=hash-link aria-label="Direct link to 1c-update-the-eslint-config-file-eslintrc" title="Direct link to 1c-update-the-eslint-config-file-eslintrc"></a></h5>
|
55
|
+
<p>Find the string <code>'plugin:vue/essential'</code> in your <code>extends</code> block and change it to <code>'plugin:vue/vue3-essential'</code>. If you don't have that plugin in your <code>extends</code> block, or you're missing that block entirely, then add this. It will help find breaking changes in how your code is using the Vue API.</p>
|
56
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">extends</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:vue/vue3-essential'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// change this from plugin:vue/essential</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:prettier/recommended'</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 string" style="color:rgb(173, 219, 103)">'@vue/prettier'</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 punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
57
|
+
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1d-fix-build-and-runtime-warnings-and-errors>(1.d) Fix build and runtime warnings and errors<a href=#1d-fix-build-and-runtime-warnings-and-errors class=hash-link aria-label="Direct link to (1.d) Fix build and runtime warnings and errors" title="Direct link to (1.d) Fix build and runtime warnings and errors"></a></h5>
|
58
|
+
<p>Run your linting and build scripts (e.g. <code>yarn lint</code> and <code>yarn build</code>). The eslint plugin and Vue's compat mode will find the first set of code changes you need to address. Fix these lint/build errors until your project builds successfully.</p>
|
59
|
+
<p>Once it builds, run your project like you would for development. It's recommended to serve it from a local dev server with <code>yarn serve</code> and add it to the import map overrides in the browser. Test the functionality of your tool and address any Vue errors and warnings that get printed to the browser console in the dev tools. <em>(NOTE: On <code>MODE: 2</code> - your first pass through this section - it's ok if your tool doesn't completely work yet. Just address the warnings and errors that are logged to the browser console. You'll get your tool completely working in the next step.)</em></p>
|
60
|
+
<p>From our experience migrating the COSMOS first-party tools, you'll most likely have to make changes to your <code>main.js</code> and <code>router.js</code> files at a minimum. You can reference the PR mentioned above in the "The quick and dirty way" section above to see what we changed, or search the internet for Vue 2 -> Vue 3 migration guides if you need help addressing any warnings or errors.</p>
|
61
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-2-bump-compat-mode-from-2-to-3>Step 2: Bump compat mode from 2 to 3<a href=#step-2-bump-compat-mode-from-2-to-3 class=hash-link aria-label="Direct link to Step 2: Bump compat mode from 2 to 3" title="Direct link to Step 2: Bump compat mode from 2 to 3"></a></h4>
|
62
|
+
<p>Change the <code>compatConfig</code> you added to your vue config file (<code>vue.config.js</code>) from <code>MODE: 2</code> to <code>MODE: 3</code>. This will tell Vue's compat mode that you've addressed the changes in the previous step, and it will find the next set of issues (since this is a multi-step process). Repeat the "(1.d) Fix build and runtime warnings and errors" step.</p>
|
63
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-3-update-vuetify>Step 3: Update Vuetify<a href=#step-3-update-vuetify class=hash-link aria-label="Direct link to Step 3: Update Vuetify" title="Direct link to Step 3: Update Vuetify"></a></h4>
|
64
|
+
<p><em>If you're not using Vuetify, you can skip this step.</em></p>
|
65
|
+
<p>Modify your eslint config (<code>.eslintrc</code>) again to add the Vuetify plugin:</p>
|
66
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">extends</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:vue/vue3-essential'</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 string" style="color:rgb(173, 219, 103)">'plugin:vuetify/base'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:prettier/recommended'</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 string" style="color:rgb(173, 219, 103)">'@vue/prettier'</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 punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
67
|
+
<p><strong>Note:</strong> The Vuetify eslint plugin is only designed for migrating projects from Vuetify 2 to Vuetify 3 and can cause linting performance issues, so it should be removed once your tool migration is complete.</p>
|
68
|
+
<p>Again in <code>.eslintrc</code>, find your <code>parserOptions</code> block and add the <code>parser</code> property above it:</p>
|
69
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token literal-property property" style="color:rgb(128, 203, 196)">parser</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'vue-eslint-parser'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token literal-property property" style="color:rgb(128, 203, 196)">parserOptions</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token spread operator" style="color:rgb(127, 219, 202)">...</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
70
|
+
<p>Now when you run eslint, it can tell you about any changes you'll need to address regarding how your code is using the Vuetify API. To find these changes, run eslint on your Vue files (e.g. <code>yarn eslint . --ext .vue</code>). You can address these manually, or if you trust eslint or have good version control, you can have the plugin fix most of them automatically with <code>yarn eslint . --ext .vue --fix</code></p>
|
71
|
+
<p>Lastly, if you are using the Astro UXDS icons via Vuetify from COSMOS - or any custom icon packs for that matter - then you'll need to change their pack alias format from <code>$packName-</code> to <code>packName:</code>. Here's an example for the <code>antenna-transmit</code> Astro icon:</p>
|
72
|
+
<div class="language-html codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-html codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"><!-- Vue 2 / Vuetify 2 (old) --></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"><</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"> $astro-antenna-transmit </span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"></</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"><!-- Vue 3 / Vuetify 3 (new) --></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"><</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"> astro:antenna-transmit </span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"></</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
73
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-4-clean-up>Step 4: Clean up<a href=#step-4-clean-up class=hash-link aria-label="Direct link to Step 4: Clean up" title="Direct link to Step 4: Clean up"></a></h4>
|
74
|
+
<ul>
|
75
|
+
<li>Remove the <code>@vue/compat</code> and <code>eslint-plugin-vuetify</code> dependencies you added in step 1.a</li>
|
76
|
+
<li>Remove the <code>compatConfig</code> you added in step 1.b</li>
|
77
|
+
<li>Remove the <code>'plugin:vuetify/base'</code> you added in step 3</li>
|
78
|
+
</ul>
|
79
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=migrating-to-the-new-openc3-common-packages>Migrating to the new OpenC3 common packages<a href=#migrating-to-the-new-openc3-common-packages class=hash-link aria-label="Direct link to Migrating to the new OpenC3 common packages" title="Direct link to Migrating to the new OpenC3 common packages"></a></h3>
|
80
|
+
<p>As mentioned in the first paragraph of this guide, we've deprecated the <code>@openc3/tool-common</code> NPM package. All of its functionality has remained the same, but everything is organized differently, so you'll have to update your dependencies and imports.</p>
|
81
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-1-update-dependencies>Step 1: Update dependencies<a href=#step-1-update-dependencies class=hash-link aria-label="Direct link to Step 1: Update dependencies" title="Direct link to Step 1: Update dependencies"></a></h4>
|
82
|
+
<p>Use your package manager or edit the package.json file to update the following dependencies</p>
|
83
|
+
<ul>
|
84
|
+
<li><strong>Remove:</strong> <code>@openc3/tool-common</code></li>
|
85
|
+
<li><strong>Add:</strong> <code>@openc3/js-common</code> >= 6.0 (<a href=https://www.npmjs.com/package/@openc3/js-common target=_blank rel="noopener noreferrer">npmjs.com</a>)</li>
|
86
|
+
<li><strong>Add:</strong> <code>@openc3/vue-common</code> >= 6.0 (<a href=https://www.npmjs.com/package/@openc3/vue-common target=_blank rel="noopener noreferrer">npmjs.com</a>)<!-- -->
|
87
|
+
<ul>
|
88
|
+
<li>This is only needed if you are using our Vue stuff (components, plugins, etc.)</li>
|
89
|
+
</ul>
|
90
|
+
</li>
|
91
|
+
</ul>
|
92
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-2-update-imports-in-your-code>Step 2: Update imports in your code<a href=#step-2-update-imports-in-your-code class=hash-link aria-label="Direct link to Step 2: Update imports in your code" title="Direct link to Step 2: Update imports in your code"></a></h4>
|
93
|
+
<p>In COSMOS 5, things were imported directly from <code>@openc3/tool-common</code>'s <code>src</code> directory and subsequently built into your tool by your build process. Everything in COSMOS 6 is now exported through several top-level exports in our new common packages. In general, the pattern is as follows:</p>
|
94
|
+
<ul>
|
95
|
+
<li>COSMOS 5: <code>import bar from '@openc3/tool-common/src/foo/bar'</code></li>
|
96
|
+
<li>COSMOS 6: <code>import { bar } from '@openc3/vue-common/foo'</code></li>
|
97
|
+
</ul>
|
98
|
+
<p>This pattern also lets you combine multiple import statements into one (e.g. <code>import { bar, baz } from '@openc3/vue-common/foo'</code>).</p>
|
99
|
+
<p>There are three exceptions to this pattern:</p>
|
100
|
+
<ul>
|
101
|
+
<li>Widgets are no longer under the <code>components</code> directory but instead get their own top-level export<!-- -->
|
102
|
+
<ul>
|
103
|
+
<li>Old: <code>import foo from '@openc3/tool-common/src/components/widgets/Foo</code></li>
|
104
|
+
<li>New: <code>import { foo } from '@openc3/vue-common/widgets</code></li>
|
105
|
+
</ul>
|
106
|
+
</li>
|
107
|
+
<li>Icons got the same treatment<!-- -->
|
108
|
+
<ul>
|
109
|
+
<li>Old: <code>import bar from '@openc3/tool-common/src/components/icons/Bar</code></li>
|
110
|
+
<li>New: <code>import { bar } from '@openc3/vue-common/icons</code></li>
|
111
|
+
</ul>
|
112
|
+
</li>
|
113
|
+
<li>The <code>TimeFilters</code> mixin was moved from <code>tools/base</code> to <code>util</code>
|
114
|
+
<ul>
|
115
|
+
<li>Old: <code>import TimeFilters from '@openc3/tool-common/src/tools/base/util/timeFilters</code></li>
|
116
|
+
<li>New: <code>import { TimeFilters } from '@openc3/vue-common/util</code></li>
|
117
|
+
</ul>
|
118
|
+
</li>
|
119
|
+
</ul>
|
120
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=openc3js-common><code>@openc3/js-common</code><a href=#openc3js-common class=hash-link aria-label="Direct link to openc3js-common" title="Direct link to openc3js-common"></a></h4>
|
121
|
+
<p>This package contains things previously under <code>@openc3/tool-common/src/services</code>. Anything not from that path will be in the <code>vue-common</code> package discussed below.</p>
|
122
|
+
<p>Update any of your imports from that path accordingly. Here's an example:</p>
|
123
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 5 (old)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Api</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/api"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Cable</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/cable"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">OpenC3Api</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/openc3Api"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 6 (new)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">Api</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">Cable</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">OpenC3Api</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/js-common/services"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
124
|
+
<p>This package also provides a couple more top-level imports which you likely will not need, but they might be useful, so I'll call them out here:</p>
|
125
|
+
<ul>
|
126
|
+
<li>
|
127
|
+
<p><code>import { prependBasePath } from '@openc3/js-common/utils</code> provides a function that will prepend the base path (e.g. localhost:2900) to Vue Router <code>route</code> objects and their children. This can be useful if you run into certain quirks with single-spa and vue-router 4's routing logic where you need the full path. You can see how we use it <a href=https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/src/router.js#L76 target=_blank rel="noopener noreferrer">here</a>.</p>
|
128
|
+
</li>
|
129
|
+
<li>
|
130
|
+
<p><code>import { devServerPlugin } from '@openc3/js-common/viteDevServerPlugin</code>. This Vite plugin is a temporary hack to run a local dev server for tools when migrating from webpack/vue-cli. It should be replaced with Vite's built-in <code>vite dev</code> dev server, but that's currently not working - at least in our first-party COSMOS tools. You can see how we use it <a href=https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/vite.config.js#L37 target=_blank rel="noopener noreferrer">here</a>.</p>
|
131
|
+
</li>
|
132
|
+
</ul>
|
133
|
+
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=openc3vue-common><code>@openc3/vue-common</code><a href=#openc3vue-common class=hash-link aria-label="Direct link to openc3vue-common" title="Direct link to openc3vue-common"></a></h4>
|
134
|
+
<p>This package provides all the shared Vue components we use to build our first-party tools. The main top-level exports are <code>components</code>, <code>icons</code>, <code>plugins</code>, <code>util</code>, and <code>widgets</code>. There are also some tool-specific exports that we built for code sharing with COSMOS Enterprise, which you might find useful: <code>tool/base</code>, <code>tool/admin</code>, and <code>tool/calendar</code>. Here's an example, but again, reference the pattern mentioned above.</p>
|
135
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 5 (old)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">DetailsDialog</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/DetailsDialog"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Graph</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/Graph"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Notify</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/plugins/notify"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">TimeFilters</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/tools/base/util/timeFilters"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">VWidget</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/widgets/VWidget"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 6 (new)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">DetailsDialog</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">Graph</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/components"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">Notify</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/plugins"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">TimeFilters</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/util"</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 module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">VWidget</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/widgets"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
136
|
+
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=migrating-from-cosmos-4-to-cosmos-5>Migrating From COSMOS 4 to COSMOS 5<a href=#migrating-from-cosmos-4-to-cosmos-5 class=hash-link aria-label="Direct link to Migrating From COSMOS 4 to COSMOS 5" title="Direct link to Migrating From COSMOS 4 to COSMOS 5"></a></h2>
|
137
|
+
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>All COSMOS Users</div><div class=admonitionContent_bl22><p>All COSMOS 4 users must upgrade their configuration to 5. However, the command, telemetry and screen definitions (keywords and syntax) have remained the same.</div></div>
|
138
|
+
<p>COSMOS 5 is a new architecture and treats targets as independent <a href=/tools/staticdocs/docs/configuration/plugins>plugins</a>. Thus the primary effort in porting from COSMOS 4 to COSMOS 5 is converting targets to plugins. We recommend creating plugins for each independent target (with its own interface) but targets which share an interface will need to be part of the same plugin. The reason for independent plugins is it allows the plugin to be versioned separately and more easily shared outside your specific project. If you have very project specific targets (e.g. custom hardware) those can potentially be combined for ease of deployment.</p>
|
139
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=configuration-migration-tool>Configuration Migration Tool<a href=#configuration-migration-tool class=hash-link aria-label="Direct link to Configuration Migration Tool" title="Direct link to Configuration Migration Tool"></a></h3>
|
30
140
|
<p>COSMOS 5 includes a migration tool for converting an existing COSMOS 4 configuration into a COSMOS 5 plugin. This example assumes an existing COSMOS 4 configuration at C:\COSMOS and a new COSMOS 5 installation at C:\cosmos-project. Linux users can adjust paths and change from .bat to .sh to follow along.</p>
|
31
141
|
<ol>
|
32
142
|
<li>
|
33
143
|
<p>Change to the existing COSMOS 4 configuration directory. You should see the config, lib, procedures, outputs directory. You can then run the migration tool by specifying the absolute path to the COSMOS 5 installation.</p>
|
34
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style
|
144
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\COSMOS> C:\cosmos-project\openc3.bat cli migrate -a demo</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
35
145
|
<p>This creates a new COSMOS 5 plugin called openc3-cosmos-demo with a target named DEMO containing the existing lib and procedures files as well as all the existing targets.</p>
|
36
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style
|
146
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\COSMOS> C:\cosmos-project\openc3.bat cli migrate demo-part INST</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
|
37
147
|
<p>This would create a new COSMOS 5 plugin called openc3-cosmos-demo-part with a target named DEMO_PART containing the existing lib and procedures files as well as the INST target (but no others).</p>
|
38
148
|
</li>
|
39
149
|
<li>
|
40
|
-
<p>Open the new COSMOS 5 plugin and ensure the <a href
|
150
|
+
<p>Open the new COSMOS 5 plugin and ensure the <a href=/tools/staticdocs/docs/configuration/plugins#plugintxt-configuration-file>plugin.txt</a> file is correctly configured. The migration tool doesn't create VARIABLEs or MICROSERVICEs or handle target substitution so those features will have to added manually.</p>
|
41
151
|
</li>
|
42
152
|
<li>
|
43
|
-
<p>Follow the <a href
|
153
|
+
<p>Follow the <a href=/tools/staticdocs/docs/getting-started/gettingstarted#building-your-plugin>building your plugin</a> part of the Getting Started tutorial to build your new plugin and upload it to COSMOS 5.</p>
|
44
154
|
</li>
|
45
|
-
</ol
|
46
|
-
|
47
|
-
</
|
155
|
+
</ol>
|
156
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=upgrading-custom-tools>Upgrading Custom Tools<a href=#upgrading-custom-tools class=hash-link aria-label="Direct link to Upgrading Custom Tools" title="Direct link to Upgrading Custom Tools"></a></h3>
|
157
|
+
<p>COSMOS 4 was a Qt Desktop based application. COSMOS 5 is a completely new architecture which runs natively in the browser using <a href=https://vuejs.org/ target=_blank rel="noopener noreferrer">Vue.js</a> as the Javascript framework and <a href=https://vuetifyjs.com/en/ target=_blank rel="noopener noreferrer">Vuetify</a> as the GUI library. We utilize <a href=https://single-spa.js.org/ target=_blank rel="noopener noreferrer">single-spa</a> to allow you to write COSMOS tool plugins in any language and provide <a href=https://github.com/OpenC3/cosmos/tree/main/openc3/templates target=_blank rel="noopener noreferrer">templates</a> for Vue.js (recommended), Angular, React and Svelte. Any COSMOS 4 custom tools will have to be completely re-written to run in COSMOS 5. We recommend using the native COSMOS <a href=https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages target=_blank rel="noopener noreferrer">tools</a> and finding GUI concepts and functionality that best match the tool you're trying to re-create.</p>
|
158
|
+
<p>If you need custom development get in touch at <a href=mailto:sales@openc3.com target=_blank rel="noopener noreferrer">sales@openc3.com</a>.</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/getting-started/upgrading.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/getting-started/generators><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Code Generators</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/key_concepts><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Key Concepts</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#cosmos-upgrades class="table-of-contents__link toc-highlight">COSMOS Upgrades</a><li><a href=#migrating-from-cosmos-5-to-cosmos-6 class="table-of-contents__link toc-highlight">Migrating From COSMOS 5 to COSMOS 6</a><ul><li><a href=#updating-vue class="table-of-contents__link toc-highlight">Updating Vue</a><ul><li><a href=#the-quick-and-dirty-way class="table-of-contents__link toc-highlight">The quick and dirty way</a><li><a href=#step-1-vue-compat-mode class="table-of-contents__link toc-highlight">Step 1: Vue compat mode</a><ul><li><a href=#1a-update-dependencies class="table-of-contents__link toc-highlight">(1.a) Update dependencies</a><li><a href=#1b-update-the-vue-config-file-vueconfigjs class="table-of-contents__link toc-highlight">(1.b) Update the Vue config file (<code>vue.config.js</code>)</a><li><a href=#1c-update-the-eslint-config-file-eslintrc class="table-of-contents__link toc-highlight">(1.c) Update the eslint config file (<code>.eslintrc</code>)</a><li><a href=#1d-fix-build-and-runtime-warnings-and-errors class="table-of-contents__link toc-highlight">(1.d) Fix build and runtime warnings and errors</a></ul><li><a href=#step-2-bump-compat-mode-from-2-to-3 class="table-of-contents__link toc-highlight">Step 2: Bump compat mode from 2 to 3</a><li><a href=#step-3-update-vuetify class="table-of-contents__link toc-highlight">Step 3: Update Vuetify</a><li><a href=#step-4-clean-up class="table-of-contents__link toc-highlight">Step 4: Clean up</a></ul><li><a href=#migrating-to-the-new-openc3-common-packages class="table-of-contents__link toc-highlight">Migrating to the new OpenC3 common packages</a><ul><li><a href=#step-1-update-dependencies class="table-of-contents__link toc-highlight">Step 1: Update dependencies</a><li><a href=#step-2-update-imports-in-your-code class="table-of-contents__link toc-highlight">Step 2: Update imports in your code</a><li><a href=#openc3js-common class="table-of-contents__link toc-highlight"><code>@openc3/js-common</code></a><li><a href=#openc3vue-common class="table-of-contents__link toc-highlight"><code>@openc3/vue-common</code></a></ul></ul><li><a href=#migrating-from-cosmos-4-to-cosmos-5 class="table-of-contents__link toc-highlight">Migrating From COSMOS 4 to COSMOS 5</a><ul><li><a href=#configuration-migration-tool class="table-of-contents__link toc-highlight">Configuration Migration Tool</a><li><a href=#upgrading-custom-tools class="table-of-contents__link toc-highlight">Upgrading Custom Tools</a></ul></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
@@ -1,13 +1 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated="false">
|
3
|
-
<head>
|
4
|
-
<meta charset="UTF-8">
|
5
|
-
<meta name="generator" content="Docusaurus v3.5.2">
|
6
|
-
<title data-rh="true">Getting Started | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started"><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="Getting Started | OpenC3 Docs"><meta data-rh="true" name="description" content="Get started with OpenC3 COSMOS"><meta data-rh="true" property="og:description" content="Get started with OpenC3 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/getting-started"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.cb8e940d.js" defer="defer"></script>
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.03e795fe.js" defer="defer"></script>
|
9
|
-
</head>
|
10
|
-
<body class="navigation-with-keyboard">
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_ak01"><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Getting Started</span><meta itemprop="position" content="1"></li></ul></nav><header><h1 class="title_AulG">Getting Started</h1><p>Get started with OpenC3 COSMOS</p></header><article class="margin-top--lg"><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/installation"><h2 class="text--truncate cardTitle_h48N" title="Installation">📄️<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_CytT" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/gettingstarted"><h2 class="text--truncate cardTitle_h48N" title="Getting Started">📄️<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_CytT" title="Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project.">Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/generators"><h2 class="text--truncate cardTitle_h48N" title="Code Generators">📄️<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_CytT" title="The COSMOS Code Generators are built into the scripts openc3.sh and openc3.bat that are included in the COSMOS project (more about projects).">The COSMOS Code Generators are built into the scripts openc3.sh and openc3.bat that are included in the COSMOS project (more about projects).</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/upgrading"><h2 class="text--truncate cardTitle_h48N" title="Upgrading">📄️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_CytT" title="COSMOS Upgrades">COSMOS Upgrades</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/key_concepts"><h2 class="text--truncate cardTitle_h48N" title="Key Concepts">📄️<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_CytT" title="Projects">Projects</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/requirements"><h2 class="text--truncate cardTitle_h48N" title="Requirements and Design">📄️<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_CytT" title="OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations.">OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations.</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_Shn5" href="/tools/staticdocs/docs/getting-started/podman"><h2 class="text--truncate cardTitle_h48N" title="Podman">📄️<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_CytT" title="OpenC3 COSMOS Using Rootless Podman and Docker-Compose">OpenC3 COSMOS Using Rootless Podman and Docker-Compose</p></a></article></section></article><footer class="margin-top--lg"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/installation"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installation</div></a></nav></footer></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
12
|
-
</body>
|
13
|
-
</html>
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Getting Started | 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/getting-started><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="Getting Started | OpenC3 Docs"><meta data-rh=true name=description content="Get started with OpenC3 COSMOS"><meta data-rh=true property=og:description content="Get started with OpenC3 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/getting-started><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.cb6ff8de.js defer></script><script src=/tools/staticdocs/assets/js/main.c4acbd62.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation>Installation</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/getting-started/gettingstarted>Getting Started</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/getting-started/generators>Code Generators</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/getting-started/upgrading>Upgrading</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/getting-started/key_concepts>Key Concepts</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/getting-started/requirements>Requirements and Design</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/getting-started/podman>Podman</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/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 menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Getting Started</span><meta itemprop=position content=1></ul></nav><header><h1 class=title_AulG>Getting Started</h1><p>Get started with OpenC3 COSMOS</header><article class=margin-top--lg><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/installation><h2 class="text--truncate cardTitle_HoSo" title=Installation>💾<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_c27F" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/gettingstarted><h2 class="text--truncate cardTitle_HoSo" title="Getting Started">🧑💻<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_c27F" title="Getting starting with COSMOS">Getting starting with COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/generators><h2 class="text--truncate cardTitle_HoSo" title="Code Generators">🏭<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh to generate code">Using openc3.sh to generate code</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/upgrading><h2 class="text--truncate cardTitle_HoSo" title=Upgrading>⬆️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_c27F" title="How to upgrade and migrate COSMOS">How to upgrade and migrate COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/key_concepts><h2 class="text--truncate cardTitle_HoSo" title="Key Concepts">💡<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_c27F" title="Projects, Containerization, Frontend, Backend">Projects, Containerization, Frontend, Backend</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/requirements><h2 class="text--truncate cardTitle_HoSo" title="Requirements and Design">📑<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_c27F" title="COSMOS Requirements and Design">COSMOS Requirements and Design</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/podman><h2 class="text--truncate cardTitle_HoSo" title=Podman>🫛<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_c27F" title="Installing and running COSMOS with Podman">Installing and running COSMOS with Podman</p></a></article></section></article><footer class=margin-top--lg><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/installation><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Installation</div></a></nav></footer></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|