Skip to content

Commit

Permalink
content: usage: overview: new in 1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ES-Alexander committed Nov 11, 2024
1 parent c5de24e commit 3f065e4
Showing 1 changed file with 45 additions and 52 deletions.
97 changes: 45 additions & 52 deletions content/usage/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,73 +38,66 @@ As the core development team we've tried to envision the future of the onboard c

Some of these principles will only be evident in future releases, but the underlying software architecture and organization have been designed from the ground up to support and enable them.

## What's New in BlueOS-1.2?
## What's New in BlueOS-1.3?

This covers a summary of the major changes and new features in BlueOS-1.2. Where applicable relevant features are also included in the [feature comparison table](#feature-comparison). For detailed coverage of every change, please see the [full release notes](https://github.com/bluerobotics/BlueOS-docker/releases).

### [Bootstrap](../../development/bootstrap/)
- Resolves the issue where BlueOS would revert to its factor image
- It is recommended to update bootstrap via the [BlueOS Version](../advanced/#blueos-version)
once you have updated to BlueOS 1.2 (requires turning on [Pirate Mode](../advanced/#pirate-mode))
This covers a summary of the major changes and new features in BlueOS-1.3. Where applicable relevant features are also included in the [feature comparison table](#feature-comparison). For detailed coverage of every change, please see the [full release notes](https://github.com/bluerobotics/BlueOS-docker/releases).

### [Extensions](../../development/extensions/)
- A standard folder for binding to the filesystem, accessible from the [File Browser](../advanced/#file-browser)
- Support for custom SVG icons
- Support for disabling iframe embedding
- Development process documentation
- [BlueOS-Community GitHub organisation](https://github.com/orgs/BlueOS-community/repositories), including
- Open-source extension examples
- A [deployment action](https://github.com/BlueOS-community/Deploy-BlueOS-Extension), for automatic building and upload of extension Docker images
- Extension development quickstart/template repositories
- Added support for extensions that are installed by default with BlueOS

### Header Bar
- Added GPS status indicator

### Page improvements
- [Extensions Manager](../advanced/#extensions-manager)
- Added disk usage display for installed extensions
- [File Browser](../advanced/#file-browser)
- New shortcuts to useful parts of the file-system
- Added support for Lua scripts for Navigator
- [MAVLink Endpoints](../advanced/#mavlink-endpoints)
- Added MAVP2P as an alternative MAVLink routing option
- [MAVLink Inspector](../advanced/#mavlink-inspector)
- Added nice summaries of pressure messages
- General interface improvements
- [Serial Bridges](../advanced/#serial-bridges)
- Splits UDP port handling into separate target and listener ports
- [Vehicle Setup](../advanced/#vehicle-setup)
- Improved sensor status indicators
- Load recommended parameter sets
- Added motor reversal configuration interface
- Added sensor calibration functionalities
- Added intuitive failsafe configuration options
- [Video Streams](../advanced/#video-streams)
- More RTSP options

### Device/Hardware Support
- Improved development support for devices without a default `pi` user, and that should have some services disabled on startup
- Support added for the extended MAVLink [`MANUAL_CONTROL`](https://mavlink.io/en/services/manual_control.html) protocol, allowing
supporting autopilot firmwares (e.g. ArduSub >= 4.1.2) to receive full 6DOF control and up to 32 button signals from a joystick
- Added support for the Raspberry Pi Compute Module 4
- Added support for external wifi adapters

### [Data Privacy](../privacy/)
- Added Sentry telemetry for error logs

### [Data Privacy](../privacy)
- Added anonymous telemetry for usage statistics
### [Contributors](../../development/overview/)
- Added [Contributor Code of Conduct](https://github.com/bluerobotics/BlueOS/blob/master/CoC.md)

## Feature Comparison

BlueOS has almost all features from the old Companion, and several hotly-requested new ones too!

| Feature | BlueOS 1.2 | BlueOS 1.1 | BlueOS 1.0 | Companion |
|---|---|---|---|---|
| [**Onboard Computer**](@/integrations/hardware/required/onboard-computer/index.md) | &rarr; | &rarr;<br>+ Other Linux-based SBCs images to come | + Raspberry Pi 3B / 3B+ / 4B supported<br>+ You can install from scratch using the installation script in any Linux computer. (Modifications may be necessary for your hardware configuration) | Raspberry Pi 3B required |
| [**Flight Controller**](@/integrations/hardware/required/flight-controller/index.md) | &rarr; | &rarr;<br>+ Cube Orange<br>+ Pixhawk 6X | &rarr;<br>+ Navigator<br>+ Pixhawk 4 | Pixhawk |
| [**Video Streams**](../advanced/#video-streams) | &rarr; | &rarr;<br>+ MPEG and YUYV encodings<br><br>+ Supports Raspberry Pi cameras | + Easily manage *multiple streams*<br><br>+ UDP and RTSP outputs<br><br>- Audio streaming<br>*not yet supported* ([#990](https://github.com/bluerobotics/BlueOS-docker/issues/990)) | Select a *single* camera to stream over UDP<br>+ Supports Raspberry Pi cameras ([except HQ Camera](https://discuss.bluerobotics.com/t/raspberry-pi-camera-stream-not-working/11976/18))<br>+ Supports a single audio stream over UDP |
| [**WIFI Manager**](../advanced/#indicators-and-network-configuration) | &rarr; | &rarr;<br>+ Vehicle provides local hotspot | &rarr;<br>+ Connect to and manage *multiple networks*, like a cellphone or computer WIFI manager | Connect to a *single network*<br>+ Visible and hidden networks supported |
| [**Ethernet Manager**](../advanced/#indicators-and-network-configuration) | &rarr; | &rarr; | *Multiple* static IPs *and* DHCP configuration | *Single* DHCP (client or server) *or* static network |
| [**Notification system**](../advanced/#header-indicators-and-blueos-configuration) | &rarr; | &rarr; | Notifications about issues, new releases, and the status of your system. | - |
| [**File Browser**](../advanced/#file-browser) | &rarr;<br>+ Folder for extension data and configuration files | &rarr; | &rarr;<br>+ *Edit files* from the browser | Download and upload files |
| [**Log Browser**](../advanced/#log-browser) | &rarr; | &rarr; | *Download and manage logs* from the browser<br>+ *Visualise and analyse logs* from the built in viewer | Ssh/terminal only |
| [**MAVLink inspector**](../advanced/#mavlink-inspector) | &rarr; | &rarr;<br>+ MAVLink2REST "watcher" option for individual message types | See and *inspect MAVLink messages in real time* from the browser | See latest MAVLink messages via MAVLink2REST |
| [**Network test**](../advanced/#network-test) | &rarr; | &rarr;<br>+ Graph during speed tests | &rarr;<br>+ Check *real time latency* | Check upload and download speed from the Control Station Computer to the vehicle's Onboard Computer |
| [**System information**](../advanced/#system-information) | &rarr; | &rarr; | Provides all the necessary information about the hardware, operating system, running processes, CPU, memory, disk, network usage and status | Basic usage statistics, list of connected devices |
| [**Web Terminal**](../advanced/#terminal) | &rarr;<br>+ Support for non-`pi` users | &rarr; | &rarr;<br>+ Uses a tmux session | Access Linux terminal from the browser |
| [**Autopilot Firmware**](../advanced/#autopilot-firmware) | &rarr; | &rarr; | &rarr;<br>+ *General ArduPilot* downloads;<br>+ *select vehicle* to update | `stable`, `beta`, and `devel` releases, custom uploads, and restore default parameters;<br>*ArduSub-only* downloads |
| [**Autopilot Parameters**](../advanced/#autopilot-parameters) | &rarr; | View, search, and edit vehicle parameters | - | - |
| [**Version Chooser**](../advanced/#blueos-version) | &rarr; | &rarr;<br>+ Bootstrap updates | + *Easily update/downgrade* between BlueOS versions, including locally stored<br>+ Includes *stable, beta, and master* releases*<br>+ Available even if main site failing | Update Companion to *latest stable only* |
| [**MAVLink Endpoints**](../advanced/#mavlink-endpoints) | &rarr; | &rarr; | &rarr; | Create and manage UDP, TCP, and serial MAVLink endpoints |
| [**NMEA support**](../advanced/#nmea-injector) | &rarr; | &rarr; | &rarr; | Conveys GPS positions to the vehicle |
| [**Ping Sonar Devices**](../advanced/#ping-sonar-devices) | &rarr; | &rarr;<br>+ Detects Ping360 in ethernet configuration<br>+ Ping Sonar distance estimates can be *sent via MAVLink* | &rarr;<br>+ Devices can be *hot-plugged*<br><br>- *No MAVLink pipeline* | Ping Sonar and Ping360 can connect with [Ping Viewer](https://docs.bluerobotics.com/ping-viewer/)<br>+ Ping Sonar distance estimates can be *sent via MAVLink* |
| [**Serial Bridges**](../advanced/#serial-bridges) | &rarr; | &rarr; | &rarr; | Create and manage bridges between serial and UDP/TCP endpoints |
| **Water Linked** | &rarr; | DVL-A50 and UGPS extensions available through Extensions Manager | [DVL-A50 package available](https://discuss.bluerobotics.com/t/external-integrations-extensions/10912#integration-example-dvl-5) | Supports UGPS and DVL-A50 |
| [**Extensions**](../extensions/) | &rarr; | Custom extensions available through Extensions Manager | &rarr; | Custom functionality requires forking the codebase |
| Feature | BlueOS 1.3 | BlueOS 1.2 | BlueOS 1.1 | BlueOS 1.0 | Companion |
|---|---|---|---|---|---|
| [**Onboard Computer**](@/integrations/hardware/required/onboard-computer/index.md) | &rarr;<br>+ Raspberry Pi CM4 | &rarr; | &rarr;<br>+ Other Linux-based SBCs images to come | + Raspberry Pi 3B / 3B+ / 4B supported<br>+ You can install from scratch using the installation script in any Linux computer. (Modifications may be necessary for your hardware configuration) | Raspberry Pi 3B required |
| [**Flight Controller**](@/integrations/hardware/required/flight-controller/index.md) | &rarr; | &rarr; | &rarr;<br>+ Cube Orange<br>+ Pixhawk 6X | &rarr;<br>+ Navigator<br>+ Pixhawk 4 | Pixhawk |
| [**Video Streams**](../advanced/#video-streams) | &rarr;<br>+ RTSP variants | &rarr; | &rarr;<br>+ MPEG and YUYV encodings<br><br>+ Supports Raspberry Pi cameras | + Easily manage *multiple streams*<br><br>+ UDP and RTSP outputs<br><br>- Audio streaming<br>*not yet supported* ([#990](https://github.com/bluerobotics/BlueOS-docker/issues/990)) | Select a *single* camera to stream over UDP<br>+ Supports Raspberry Pi cameras ([except HQ Camera](https://discuss.bluerobotics.com/t/raspberry-pi-camera-stream-not-working/11976/18))<br>+ Supports a single audio stream over UDP |
| [**WIFI Manager**](../advanced/#indicators-and-network-configuration) | &rarr;<br>+ External adapter support | &rarr; | &rarr;<br>+ Vehicle provides local hotspot | &rarr;<br>+ Connect to and manage *multiple networks*, like a cellphone or computer WIFI manager | Connect to a *single network*<br>+ Visible and hidden networks supported |
| [**Ethernet Manager**](../advanced/#indicators-and-network-configuration) | &rarr; | &rarr; | &rarr; | *Multiple* static IPs *and* DHCP configuration | *Single* DHCP (client or server) *or* static network |
| [**Notification system**](../advanced/#header-indicators-and-blueos-configuration) | &rarr; | &rarr; | &rarr; | Notifications about issues, new releases, and the status of your system. | - |
| [**File Browser**](../advanced/#file-browser) | &rarr; | &rarr;<br>+ Folder for extension data and configuration files | &rarr; | &rarr;<br>+ *Edit files* from the browser | Download and upload files |
| [**Log Browser**](../advanced/#log-browser) | &rarr; | &rarr; | &rarr; | *Download and manage logs* from the browser<br>+ *Visualise and analyse logs* from the built in viewer | Ssh/terminal only |
| [**MAVLink inspector**](../advanced/#mavlink-inspector) | &rarr; | &rarr; | &rarr;<br>+ MAVLink2REST "watcher" option for individual message types | See and *inspect MAVLink messages in real time* from the browser | See latest MAVLink messages via MAVLink2REST |
| [**Network test**](../advanced/#network-test) | &rarr; | &rarr; | &rarr;<br>+ Graph during speed tests | &rarr;<br>+ Check *real time latency* | Check upload and download speed from the Control Station Computer to the vehicle's Onboard Computer |
| [**System information**](../advanced/#system-information) | &rarr; | &rarr; | &rarr; | Provides all the necessary information about the hardware, operating system, running processes, CPU, memory, disk, network usage and status | Basic usage statistics, list of connected devices |
| [**Web Terminal**](../advanced/#terminal) | &rarr; | &rarr;<br>+ Support for non-`pi` users | &rarr; | &rarr;<br>+ Uses a tmux session | Access Linux terminal from the browser |
| [**Autopilot Firmware**](../advanced/#autopilot-firmware) | &rarr; | &rarr; | &rarr; | &rarr;<br>+ *General ArduPilot* downloads;<br>+ *select vehicle* to update | `stable`, `beta`, and `devel` releases, custom uploads, and restore default parameters;<br>*ArduSub-only* downloads |
| [**Autopilot Parameters**](../advanced/#autopilot-parameters) | &rarr;<br>+ Intuitive ArduPilot calibrations and configuration<br>+ PX4 parameter descriptions | &rarr; | View, search, and edit ArduPilot vehicle parameters | - | - |
| [**Version Chooser**](../advanced/#blueos-version) | &rarr; | &rarr; | &rarr;<br>+ Bootstrap updates | + *Easily update/downgrade* between BlueOS versions, including locally stored<br>+ Includes *stable, beta, and master* releases*<br>+ Available even if main site failing | Update Companion to *latest stable only* |
| [**MAVLink Endpoints**](../advanced/#mavlink-endpoints) | &rarr;<br>+ Log messages in `.tlog` files | &rarr;<br>+ Choose routing service | &rarr; | &rarr; | Create and manage UDP, TCP, and serial MAVLink endpoints |
| [**NMEA support**](../advanced/#nmea-injector) | &rarr; | &rarr; | &rarr; | &rarr; | Conveys GPS positions to the vehicle |
| [**Ping Sonar Devices**](../advanced/#ping-sonar-devices) | &rarr; | &rarr; | &rarr;<br>+ Detects Ping360 in ethernet configuration<br>+ Ping Sonar distance estimates can be *sent via MAVLink* | &rarr;<br>+ Devices can be *hot-plugged*<br><br>- *No MAVLink pipeline* | Ping Sonar and Ping360 can connect with [Ping Viewer](https://docs.bluerobotics.com/ping-viewer/)<br>+ Ping Sonar distance estimates can be *sent via MAVLink* |
| [**Serial Bridges**](../advanced/#serial-bridges) | &rarr;<br>+ Separate target and listener ports | &rarr; | &rarr; | &rarr; | Create and manage bridges between serial and UDP/TCP endpoints |
| **Water Linked** | &rarr; | &rarr; | DVL-A50 and UGPS extensions available through Extensions Manager | [DVL-A50 package available](https://discuss.bluerobotics.com/t/external-integrations-extensions/10912#integration-example-dvl-5) | Supports UGPS and DVL-A50 |
| [**Extensions**](../extensions/) | &rarr; | &rarr; | Custom extensions available through Extensions Manager | &rarr; | Custom functionality requires forking the codebase |

## Release Types
BlueOS has multiple release types, to allow choosing your preferred balance between access to the latest fixes and improvements, and stability of the software. The three release types are:
Expand Down

0 comments on commit 3f065e4

Please sign in to comment.