Releases: OpenC3/cosmos
v5.19.0
OpenC3 COSMOS 5.19.0 - Command History and Validators (Enterprise)
Welcome to OpenC3 COSMOS 5.19.0!
This is an exciting release as we have a completely new tool for Enterprise Users - Command History! It provides a quick way to see what commands have been sent, by who, and if the commands were successful.
Associated is a new feature called Command Validators that is available for both Open Source and Enterprise Users. This feature allows us to know if the command was successful after its full lifecycle. Read more below.
Additionally we have grown to the point where security researchers are looking into COSMOS and creating CVEs. This release patches three CVEs that have been written against COSMOS. As always, we recommend updating to our latest version.
Affects Both Open Source and Enterprise Edition:
- CVE-2024-46977 - Path traversal via screen controller (
[GHSL-2024-127]
) - Moderate
Only Affects Open Source Edition:
- CVE-2024-43795 - Cross-site scripting in Login functionality (
GHSL-2024-128
) - High - CVE-2024-47529 - Clear text storage of password/token (
GHSL-2024-129
) - Moderate
Command History Tool (Enterprise)
A new tool for our Enterprise users provides a quick way to see what commands have been sent, by who, and if the commands were successful.
Command Validators
Commands validators are a new class that can be associated with individual commands. Inside the class are a pre_check and post_check method which can be used to reject commands before they are sent (pre_check), or verify if the command worked successfully (post_check).
Python Redis Cluster Support (Enterprise)
Python now supports infinite scaling with Redis Cluster in COSMOS Enterprise Edition.
New Runner Role (Enterprise)
We have a new default role called "runner" that allows a user to run scripts but not edit them. Great for production environments where users are only authorized to run prebuilt scripts.
New DataViewer Item Component
This provides an easy way to scale viewing an item (or multiple items) over time in DataViewer (rather than an entire packet).
Time Zone Setting
Our settings page now includes a time zone setting where you can choose whether you want every tool to use UTC time or the local time zone.
Potentially Breaking Changes
- Our command line generators no longer default to ruby and now require --ruby or --python for each (or set the OPENC3_LANGUAGE environment variable)
- Updated to use docker compose run instead of docker run for cli actions in openc3.sh/openc3.bat
- The docker network is no longer hard coded in compose.yaml and is now auto set by Docker Compose
- RECEIVED_COUNT now returns 0 instead of nil/None for packets that have never been received
- Many more log messages are now JSON formatted
Other Improvements
- Added a ScriptRunner Line Delay Menu Option
- More Consistent use of 401 and 403 errors
- Python Stack Traces are now cleaner in ScriptRunner
- Greatly improved File Open Performance with a large number of files
- CmdTlmApi and ScriptRunner Rails logs are now JSON formatted
- Added the ability to clear graph data in TlmGrapher
- Bucket Explorer auto refreshes every minute
Other Bug Fixes
- Fixed a python wait_check bug causing it to block forever
- Improved escaping logic in TemplateAccessor
- Lots of spelling errors fixed - our pipeline now checks for spelling errors! (Typically in comments)
- Fixed a bug with the script open_file_dialog sometimes not working
- Command Sender error messages could reference the wrong command
- Fixed TlmViewer Spacer widget
- Fixed a bug with mixing old variable sized items with new variable sized items
- Fixed an issue with CmdTlmServer LogMessages not bringing up any history
- Fixed python tcpip_server_interface
All Pull Requests in this Release
- Coverage by @JL-Brothers in #1415
- Generator requires language by @JL-Brothers in #1490
- Better escaping in TemplateAccessor by @jmthomas in #1495
- Rework settings and add time zone by @jmthomas in #1446
- Correct spelling errors by @jmthomas in #1496
- Fix fileDialogCallback promise logic by @jmthomas in #1497
- Bump webpack from 5.93.0 to 5.94.0 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-packetviewer by @dependabot in #1502
- Cmd validation by @jmthomas in #1506
- Bump pypa/gh-action-pypi-publish from 1.9.0 to 1.10.0 by @dependabot in #1508
- Bump webpack from 5.93.0 to 5.94.0 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-dataviewer by @dependabot in #1507
- Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 by @dependabot in #1524
- Bump webpack from 5.93.0 to 5.94.0 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-dataextractor by @dependabot in #1520
- Fix get_limits docs by @jmthomas in #1538
- Bump webpack from 5.93.0 to 5.94.0 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver by @dependabot in #1533
- Fix Command Sender error message by @jmthomas in #1516
- Bump webpack from 5.93.0 to 5.94.0 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdsender by @dependabot in #1541
- Bump the npm_and_yarn group across 13 directories with 1 update by @dependabot in #1542
- Http interface tests by @JL-Brothers in #1513
- SR line delay menu option and log line delay changes by @jmthomas in #1540
- Python Redis Cluster Updates (Enterprise) by @ryanmelt in #1523
- Add runner role to SR by @jmthomas in #1519
- Applied OPENC3_OPERATOR_HOSTNAME to json_api.rb by @stephen-ritter in #1511
- Cli script wait by @JL-Brothers in #1501
- Allow upload and delete to /tmp by @jmthomas in #1544
- Properly return 403 for Forbidden by @ryanmelt in #1555
- Fix spacer widget by @jmthomas in #1553
- Fix python stack traces by @jmthomas in #1554
- Update SR file open / save dialog by @jmthomas in #1556
- Bump pypa/gh-action-pypi-publish from 1.10.1 to 1.10.2 by @dependabot in #1565
- Command validator returns true, false, nil by @jmthomas in #1561
- Improve target file performance by @jmthomas in #1560
- Setup rails for JSON logging by @ryanmelt in #1568
- Add ability to clear graph data by @jmthomas in #1570
- Add uuid to activities by @jmthomas in #1522
- RECEIVED_COUNT returns 0 if packet not received by @jmthomas in #1569
- Fix spec return code by @jmthomas in #1518
- Change cmd keyword from validator to validate by @jmthomas in #1574
- Fix python sleep and screen formatValue by @jmthomas in #1576
- Deterministic recalculate bit offsets by @ryanmelt in #1577
- Fix LogMessages history by @jmthomas in #1587
- Fix python tcpip_server_interface by @jmthomas in #1578
- Dependencies by @jmthomas in #1582
- Rework Graph edit dialog, change timezone in Astro clock by @jmthomas in #1583
- Add auto-refresh to Bucket Explorer by @ryan-pratt in #1585
- Address security issues by @ryanmelt in #1589
- cli updates by @ryanmelt in #1588
- Dv items by @jmthomas in #1593
- Fix tlm grapher button layout by @jmthomas in #1594
- Roadmap by @jmthomas in #1599
- Bump uplot from 1.6.30 to 1.6.31 in /openc3-cosmos-init/plugins/packages/openc3-tool-common in the npm_and_yarn group across 1 directory by @dependabot in #1602
- Fix Bucket Explorer auto-refresh playwright test for enterprise by @ryan-pratt in #1601
- Command authority documentation by @jmthomas in #1600
New Contributors
- @JL-Brothers made their first contribution in #1415
- @ryan-pratt made their first contribution in #1585
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB ...
v5.18.0
OpenC3 COSMOS 5.18.0 - Multiple variable bit size items in the same packet!
Welcome to OpenC3 COSMOS 5.18.0!
Multiple Variable Bit Size Items
Since the beginning, COSMOS has been able to handle a single variable sized item within packets. Now we can handle multiple! As long as each item has its own associated length field, you can have multiple variable sized items in the same packet.
See the new VARIABLE_BIT_SIZE keyword for packet definitions.
Command Authority (Enterprise)
In COSMOS Enterprise, you can now enable a new mode called Command Authority. In this mode, only one user at a time can command a given target. This can be helpful on multi-operator ops floors to prevent two operators from accidentally sending commands at the same time.
Chromeless mode
Sometimes you would like to open COSMOS up in an IFRAME or a browser tab, and not waste any space with the topbar, navbar, or footer. Well now you can! Just add ?chromeless=true
to your urls and check it out.
New Subtitle Setting
There is a new setting in Admin -> Settings, called Subtitle, that allows you to place text under the OpenC3 logo in the Navbar. This can be really useful to differentiate between multiple installations of COSMOS.
Other Improvements
- Added a new OPENC3_OPERATOR_HOSTNAME environment variable to support pointing to a regular operator while running in Kubernetes (vs the Kubernetes Operator)
- Updated BucketExplorer to show newest files first by default
- Changed Calendar (Enterprise) to allow overlapping activities
- Added a new Signal Strength Widget for TlmViewer
- Moved some log messages to debug within the operator to quiet down microservice start/stop
- Added support for Array indexing in TlmViewer LINEGRAPH
- Added the ability to disable Calendar execution (Enterprise)
- Blank screen widgets no longer say "Value"
- Added vim and ps to UBI images
- Added new playwright.sh to run playwright tests
Other Bug Fixes
- Fixed a timing issue with the build_cmd api that was causing ack timeouts
- Fixed TEMPLATE and Accessors for Python
- Fixed connect() being called twice in Python interfaces
- Fixed screen SUBSETTING application
- Fixed Python Websocket API authentication in Enterprise
- Fixed open_file_dialog in Python scripts
- Fixed an error that occurred if you backspaced away the full name of a telemetry item in an item chooser
- Fixed Image Viewer Widget
- Updated Progress bar to always end at 100% on plugin and package uploads
All Pull Requests in this Release
- Add environment variable for dynamic operator hostname by @ryanmelt in #1378
- Bump certifi from 2023.7.22 to 2024.7.4 in /openc3/python by @dependabot in #1382
- Update topic offsets before wait for ack by @ryanmelt in #1381
- Bucket Explorer list latest first by @jmthomas in #1387
- Bump certifi from 2023.7.22 to 2024.7.4 in /openc3/python by @dependabot in #1384
- Allow overlapping activities by @jmthomas in #1383
- Signal widget by @jmthomas in #1386
- Adjust logging output by @jmthomas in #1385
- Fix python accessors and packet restore_defaults by @jmthomas in #1399
- Remove extra connect in python_microservice by @jmthomas in #1400
- Fix applying subsettings, fix LimitscolumnWidget by @jmthomas in #1401
- Allow array index on graph widget by @jmthomas in #1402
- Add chromeless query parameter support by @ryanmelt in #1403
- Fix python web socket in Enterprise by @jmthomas in #1424
- Fix python open_file_dialog by @jmthomas in #1425
- Calendar settings by @jmthomas in #1404
- Cmd authorization support by @jmthomas in #1423
- Bump dependencies by @jmthomas in #1427
- Fix scope_model and add comments by @jmthomas in #1433
- Remove placeholder from widgets by @jmthomas in #1431
- Fix chooser when deleting values by @jmthomas in #1434
- Add subtitle setting by @jmthomas in #1435
- Fix Dockerfile. Add vim and ps to UBI images by @ryanmelt in #1441
- Multi variable bit size by @ryanmelt in #1436
- Fix markdown issue in documentation issue reporting note by @bismurphy in #1451
- Bump axios from 1.7.2 to 1.7.4 in /openc3/templates/tool_vue by @dependabot in #1472
- Bump axios from 1.7.2 to 1.7.4 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-handbooks by @dependabot in #1474
- Bump axios from 1.7.2 to 1.7.4 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver by @dependabot in #1475
- Fix offset when appending items by @jmthomas in #1454
- Image viewer widget update with tlm by @jmthomas in #1469
- Progress by @jmthomas in #1445
- Bump axios from 1.7.2 to 1.7.4 in /openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-dataviewer by @dependabot in #1476
- Add multiple variable bit length items to python by @jmthomas in #1473
- Ability to Run Playwright Tests Locally by @stephen-ritter in #1357
- Bump deps by @jmthomas in #1480
- Update docs with Python info by @jmthomas in #1483
New Contributors
- @bismurphy made their first contribution in #1451
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.17.1...v5.18.0
v5.17.1
OpenC3 COSMOS 5.17.1 - Rollup Widget, Dependency Update, and Bug Fixes
Welcome to OpenC3 COSMOS 5.17.1!
New ROLLUP Widget
We've added a new ROLLUP widget for TlmViewer that allows you to pick an icon, assign multiple telemetry items to it, and then it will change color based on the overall limits state of those items. Clicking on the icon can also bring up a telemetry screen of your choice.
ScriptRunner now role aware (Enterprise)
The ScriptRunner frontend is now role aware in Enterprise edition, which allows it to make the scripts readonly for users who can't edit scripts, and disable the start button for users who can't run scripts.
VALUE Widgets now support array indexing
You can now select individual array items for display on TlmViewer screens!
IMPORTANT Bug Fix in ScriptRunner
ScriptRunner could save over a file with an old version of the file's contents under certain circumstances when pressing Ctrl-S to save. This required: 1. Leaving ScriptRunner to another tool, 2. Returning to ScriptRunner, 3. Saving the file with Ctrl-S, 4. All without refreshing the webpage. This has been corrected.
Other Bug Fixes
- ScriptRunner can now properly import python modules with an init.py file.
- Several fixes with applying Global settings in screens
- Calendar events are now properly cleaned up and expired over time
- Python "break" now works in ScriptRunner
- Plugin Download button on the Admin Plugins tab now works
- Python range checking given a string no longer crashes
- Python code now handles limits event notifications
- Dockerfiles updated to same case FROM and AS statements
All Pull Requests in this Release
- update typing and cleanup in scripts by @GerhardOfRivia in #1296
- Codecov action v4 with token by @jmthomas in #1306
- Fix python version and update on release by @jmthomas in #1305
- ROLLUP notification widget by @jmthomas in #1322
- Make SR aware of roles by @jmthomas in #1308
- Import python target modules by @jmthomas in #1330
- Allow array index in VALUE widget by @jmthomas in #1332
- Bump pypa/gh-action-pypi-publish from 1.8.14 to 1.9.0 by @dependabot in #1349
- Fix applying global settings to widgets by @jmthomas in #1350
- Allow EXPIRE activities in the past by @jmthomas in #1333
- Prevent ScriptRunner Ctrl-S Save from Saving Old Buffers by @ryanmelt in #1356
- Fix python break and plugin download and calendar reserve type by @ryanmelt in #1358
- Check for string param when doing range checking by @jmthomas in #1337
- Fix limits event handling by @jmthomas in #1346
- update dependencies by @ryanmelt in #1367
- fix "FromAsCasing" buildkit check by @JoshuaNeely in #1368
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.16.2...v5.17.1
v5.16.2
OpenC3 COSMOS 5.16.2 - Python Script APIs and Usability Improvements
Welcome to OpenC3 COSMOS 5.16.2!
This release adds Python script APIs and addresses a number of tool usability issues.
Potentially breaking changes from 5.15.x
Script wait methods that wait on a condition now return true/false to indicate if the wait condition was successful or not. Previously these wait methods returned the number of seconds actually waited.
Other Improvements
- Improve Limits Monitor layout with timestamp and more field width
- Add Data Viewer collapsable header and expand Data Viewer widget width and height
- Expand Script Runner Message Log pane to take 100% of the bottom half
- Filter stack trace on installation for easier debugging of config errors
- Admin Plugins and Packages adds progress bar on upload and visually separates Processes from Plugins
- Added tooltips for Suite Runner checkboxes
- Right click a screen keyword to bring up a popup with a link to the documentation
- Added Python docs and typing by @GerhardOfRivia
Bug Fixes
- Do not clear interval on Packet Viewer error - this should prevent Packet Viewer from "freezing" and no long updating, especially when updating plugins
- Remove Notification Open button unless an actual URL destination is given
- Fix new scope deployment to properly log messages and cleanup
- Fix python log time in text logs returning 01/01/1970
- Allow commands in Data Viewer
All Pull Requests in this Release
- Bump requests from 2.31.0 to 2.32.0 in /openc3/python by @dependabot in #1284
- Do not clear interval on Packet Viewer error by @jmthomas in #1274
- Notifications: Only open if url, change clear icon by @jmthomas in #1291
- Change modified button to Confirm by @jmthomas in #1293
- Limits Monitor timestamp and more width by @jmthomas in #1294
- DataViewer collapsable header and full height by @jmthomas in #1295
- Script Runner panes by @jmthomas in #1292
- Deploy new scopes by @jmthomas in #1280
- Filter stack trace in ConfigParser by @jmthomas in #1275
- Python conversion generator returns value by @jmthomas in #1273
- Fix python log time by @jmthomas in #1266
- Separate Process List from Plugin List by @jmthomas in #1254
- Add popups for Suite Runner checkboxes by @jmthomas in #1268
- add more typing to python models code by @GerhardOfRivia in #1234
- Remove gosu from redis by @jmthomas in #1250
- Allow cmds in Data Viewer by @jmthomas in #1251
- Python script runner api by @jmthomas in #1282
- Right click screen keyword for docs by @jmthomas in #1252
- Add progress bar when uploading plugins by @jmthomas in #1267
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.16.1...v5.16.2
v5.16.1
OpenC3 COSMOS 5.16.1 - Command Sender History and Playwright Enhancements
Welcome to OpenC3 COSMOS 5.16.1!
This release adds some minor features, fixes the UBI build and improves our Playwright end to end testing.
Potentially breaking changes from 5.15.x
Script wait methods that wait on a condition now return true/false to indicate if the wait condition was successful or not. Previously these wait methods returned the number of seconds actually waited.
Command Sender History
Command Sender now remembers history on a browser refresh. The delete button will clear the history.
Other Improvements
- Limits Monitor clear all ignored items
- Code completion works with Python fstrings, e.g. cmd(f"INST
All Pull Requests in this Release
- Add Clear All to ignored limits by @jmthomas in #1242
- Command Sender remember history by @jmthomas in #1241
- Allow fstring in code completion by @jmthomas in #1237
- Playwright changes for enterprise by @jmthomas in #1244
- Playwright enhancements by @jmthomas in #1245
- Fix ubi build and add github action by @jmthomas in #1249
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.16.0...v5.16.1
v5.16.0
OpenC3 COSMOS 5.16.0 - Dependency Updates and Bug Fixes
Welcome to OpenC3 COSMOS 5.16.0!
This is primarily a bug fix and dependency update release. Interesting changes are documented below.
Potentially breaking changes from 5.15.x
Script wait methods that wait on a condition now return true/false to indicate if the wait condition was successful or not. Previously these wait methods returned the number of seconds actually waited.
IGNORE_OVERLAP for entire packet
IGNORE_OVERLAP can now be declared on an entire packet allowing items within to overlap without requiring adding the OVERLAP flag to every individual item.
Calendar now support recurring activities (Enterprise Only)
You can now have calendar activities automatically repeat at any desired interval.
Other Improvements
- In Enterprise, the user who started a script is now shown in the execution status display
- Item names are now sorted alphabetically in the chooser rather than in order of definition
- Info limits messages (displayed green) are now suppressed on initial packet received
- New openc3cli list command to list installed plugins
- Dependencies updated to reduce CVEs
Bug Fixes
- Fix jumping between two running scripts if a second is opened and started in the same ScriptRunner
- Numerous python related fixes
All Pull Requests in this Release
- Start add typing to python lib by @GerhardOfRivia in #1167
- Disconnect before connecting to running script by @jmthomas in #1191
- Better cli descriptions by @jmthomas in #1185
- Set combobox default by @jmthomas in #1190
- Better check for scientific notation by @jmthomas in #1188
- Download screen as lowercase screen name by @jmthomas in #1186
- Add username to Execution status by @jmthomas in #1189
- Bump idna from 3.4 to 3.7 in /openc3/python by @dependabot in #1196
- Sort items and filter targets without packets by @jmthomas in #1187
- Bump redis-client version by @jmthomas in #1199
- prevent 0 max params registering as no-maximum by @JoshuaNeely in #1209
- Add Suite Runner Example to curl.md by @tsjordan-eng in #1216
- Suppress initial limits INFO msgs by @jmthomas in #1205
- Add 'list' option to cli by @jmthomas in #1204
- Add connection_string to interface and use in interface_microservice by @jmthomas in #1184
- Fix several python packet config options by @jmthomas in #1201
- Remove slice! from fixed_protocol by @jmthomas in #1207
- IGNORE_OVERLAP in telemetry by @jmthomas in #1208
- COBS, SLIP, CmdResponse protocol docs by @jmthomas in #1206
- Recurring Calendar activities by @jmthomas in #1171
- Fix sending array in python by @jmthomas in #1223
- Fix Script execute selection and run from here by @jmthomas in #1220
- Wait methods return true/false except for wait() and wait(x) by @jmthomas in #1224
- Bump dependencies by @jmthomas in #1219
- Fix pypi url usage by @ryanmelt in #1226
- burst protocol c extension by @ryanmelt in #1225
- Fix accessor for Python by @jmthomas in #1229
- Add local option to cleanup local files by @jmthomas in #1121
- Force log encoding by @ryanmelt in #1232
- Fix playwright test by @jmthomas in #1233
New Contributors
- @GerhardOfRivia made their first contribution in #1167
- @JoshuaNeely made their first contribution in #1209
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.15.2...v5.16.0
v5.15.2
OpenC3 COSMOS 5.15.2 - script notifications and bug fixes
Welcome to OpenC3 COSMOS 5.15.2!
This release adds to the notifications icon the number of running scripts. It fixes bugs in the Python storage API and suite API. It also fixes a bug in the serial driver preventing clean disconnects.
Breaking Changes and Upgrade Notes since 5.14.2 - Please Read
- The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments
- The change requires updating .env, compose.yaml and the traefik configuration files.
- Stop the previous release, update the files, and restart
Other Improvements
- Add the number of running scripts to the Notifications icon
- Update JsonAccessor to support binary data
- Add OPENC3_BUCKET_URL to .env file (defaults to http://openc3-minio:9000)
- Script Runner automatically detects files using f-strings as Python
Bug Fixes
- Fix Python get_target_file
- Fix the ability to run Python Groups and Suites in Script Runner
- Fix serial port disconnect
All Pull Requests in this Release
- use response.content (bytes) instead of response.text (encoded text) by @ryanmelt in #1148
- Bump black from 23.3.0 to 24.3.0 in /openc3/python by @dependabot in #1151
- Add notifications for scripts by @jmthomas in #1157
- Fix screen docs by @jmthomas in #1156
- Update JsonAccessor to support additions (binary data, Nan, Infinity) by @ryanmelt in #1161
- Removed version tag from compose.yaml, compose-dev.yaml, and compose-… by @schuuust in #1160
- Fix OPENC3_BUCKET_URL in storage by @jmthomas in #1163
- Fix python suites by @jmthomas in #1164
- Fix Posix Serial Driver Not Unblocking Read on Close by @ryanmelt in #1166
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.15.1...v5.15.2
v5.15.1
OpenC3 COSMOS 5.15.1 - target file API fixes and disabled commands
Welcome to OpenC3 COSMOS 5.15.1!
This release fixes the download_file, get_target_file, and put_target_file APIs. It implements the DISABLED keyword and adds API methods to enable_cmd and disable_cmd (admins only).
Breaking Changes and Upgrade Notes since 5.14.2 - Please Read
- The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments
- The change requires updating .env, compose.yaml and the traefik configuration files.
- Stop the previous release, update the files, and restart
Bug Fixes
- Implement the DISABLED keyword
- Fix redis cluster in COSMOS Enterprise
- Fix download_file, get_target_file, put_target_file in Ruby and Python
All Pull Requests in this Release
- Bump pypa/gh-action-pypi-publish from 1.8.12 to 1.8.14 by @dependabot in #1141
- Implement DISABLED for commands by @jmthomas in #1138
- Fix redis cluster with StoredQueue by @ryanmelt in #1146
- Bump alpine build by @jmthomas in #1145
- Fix download_file and get_target_file by @jmthomas in #1143
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.15.0...v5.15.1
v5.15.0
OpenC3 COSMOS 5.15.0 - Interface Throughput Improvements
Welcome to OpenC3 COSMOS 5.15.0!
This release brings major improvements to interface throughput with a new strategy of batching writes to Redis and an additional option to interfaces to even further improvement throughput at the cost of slightly higher processing latency. If you have interfaces receiving data at greater than 10Hz, try adding OPTION OPTIMIZE_THROUGHPUT 0.1
to your interfaces.
Breaking Changes and Upgrade Notes - Please Read
- The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments
- The change requires updating .env, compose.yaml and the traefik configuration files.
- Stop the previous release, update the files, and restart
Greatly Improved TlmViewer Code Completion in Screen Editor
The screen editor is now fully aware of the telemetry database, making it even easier to quickly build out telemetry screens!
Other Improvements
- Item background colors now alternate in Admin lists
- ScriptRunner Suite report filenames now indicate what was run
- Grapher nows goes to using scientific notation for labels with very large and very small numbers
- Grapher can now add user configured horizontal lines
- Bucket Explorer can now create files in new folders
Bug Fixes
- Fixed python target file loading APIs
- The HIDDEN command keyword is now supported
- Generating presigned urls now checks targets_modified as well as the targets folder
- Fixed importing pandas in Python scripts
- Renewed support for item names that include square brackets
- Fixed cycle time support for low data rate targets
- Fixed upgrading plugins when multiple of the same plugin are installed
All Pull Requests in this Release
- Alternate list item colors by @jmthomas in #1112
- Bump ip from 2.0.0 to 2.0.1 in /openc3-cosmos-init/plugins by @dependabot in #1114
- Fix _get_uri by @ryanmelt in #1116
- Allow override AWS ARN for gov cloud, change traefik ports by @jmthomas in #1119
- Add suite, group, script to report file name by @jmthomas in #1111
- Graph high & low values with scientific notation by @jmthomas in #1108
- Hide HIDDEN commands and packets by @jmthomas in #1109
- Download presigned requests check targets_modified by @jmthomas in #1113
- Add horizontal lines to graphs by @jmthomas in #1107
- Allow setting path when uploading file by @jmthomas in #1120
- Screen completion by @jmthomas in #1117
- Fix import of pandas, and use of PYPI_URL by @ryanmelt in #1126
- Bump pypa/gh-action-pypi-publish from 1.8.11 to 1.8.12 by @dependabot in #1129
- Output warnings as WARN and import openc3-enterprise by @jmthomas in #1131
- Add option to Interfaces to Improve Throughput Through Redis Write Queueing by @ryanmelt in #1123
- Support item names with brackets by @jmthomas in #1134
- Handle upgrade with multiple installed same plugins by @ryanmelt in #1135
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: v5.14.2...v5.15.0
v5.14.2
OpenC3 COSMOS 5.14.2 - Python Bug Fix Release
Welcome to OpenC3 COSMOS 5.14.2!
This release mainly fixes issues with our new Python support. Thanks to everyone who is trying it out and submitting tickets!
Python Bug Fixes
- Custom Conversions, Limits Responses, etc our now imported successfully
- Generators now support --python fully
- UBI pip3 is now symlinked to pip
- Pip will now retry with --no-index if the attempt at an online install fails
- Handle String edge case that was breaking INST2 ASCIICMD
Other Improvements
- openc3.sh cli rake will now fail with a warning if no Rakefile is found
- The Raw dialogs in CmdTlmServer are now non-modal, allowing multiple to open and be moved around
- CmdTlmServer now has a Clear Counters option
All Pull Requests in this Release
- Handle custom python classes by @ryanmelt in #1080
- Python generators by @jmthomas in #1082
- Format developing page as code by @jmthomas in #1083
- Warn about rake without Rakefile by @jmthomas in #1084
- Allow multiple positionable raw dialogs by @jmthomas in #1088
- CmdTlmServer clear counters by @jmthomas in #1089
- Link pip3 to pip in ubi by @ryanmelt in #1092
- Pip install retry with no-index by @ryanmelt in #1093
- Handle bad string types and rescue AttributeError by @jmthomas in #1090
Prerequisites:
Docker - Running OpenC3 requires a working Docker or Podman installation. Typically Docker Desktop on Windows / Mac. Plain Docker or Podman also works on linux. We actively develop and run with Docker Desktop on Mac/Windows, and Linux on Raspberry Pi, so if you have any issues on another platform, please let us know by submitting a ticket!
Minimum Resources allocated to Docker: 4GB RAM, 1 CPU, 80GB Disk
Recommended Resources allocated to Docker: 16GB RAM, 2+ CPUs, 100GB Disk
Also requires docker compose version 1.27+
To Run:
- git clone https://github.com/openc3/cosmos-project.git cosmos-myproject
- cd cosmos-myproject
- Run Linux/Mac: ./openc3.sh run
- Run Windows: openc3.bat run
- Connect a web browser to http://localhost:2900/
- Have fun running OpenC3 COSMOS!
Please see our documentation at https://openc3.com
Try it out and let us know what you think! Please submit any issues as Github tickets, or any generic feedback to [email protected].
Thanks!
Full Changelog: Changelog