Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BlueOS-1.1] Update (2) for stable release candidate #105

Merged
36 changes: 32 additions & 4 deletions advanced-usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,23 @@ easily connect to it from a phone

{{ easy_image(src="hotspot-example", width=250, center=true) }}

##### Internet Status and Management

- See whether the vehicle is connected to the internet

{{ easy_image(src="internet", center=true, width=50) }}
{% pirate() %}
- Configure network priority ordering
- Determines which network interface is used for internet connection
- Generally `wlan0` should be at the top (for internet via wifi)
- Move `eth0` to the top if using internet passthrough via the tether
{% end %}
{{ easy_image(src="internet-network-priority", class="pirate", center=true, width=400) }}
{% pirate() %}
- View and configure DNS name servers
{% end %}
{{ easy_image(src="internet-dns-config", class="pirate", center=true, width=400) }}

##### Display Mode Management

{{ easy_image(src="display-mode", width=250, center=true) }}
Expand Down Expand Up @@ -153,6 +170,7 @@ specifies the requirements for a service page to appear in the sidebar
- Remove log files from BlueOS services (to reduce space usage on the SD card)
- Download log files from BlueOS services to report a problem
- Old logs are aggregated and kept as zip files
- Re-enable the [configuration wizard](../getting-started#wizard)

##### Power

Expand Down Expand Up @@ -296,6 +314,7 @@ versions
- Previously-installed versions are kept locally on the device, unless
manually deleted, which provides an easy route for roll-backs to undesired
changes (e.g. during development)
- Allows updating the [bootstrap image](../development/bootstrap) to match the current version
- Allows loading remote versions (including from custom docker-hub repositories)
- Allows manually uploading docker images from the surface computer
- If an undetected failure somehow occurs in BlueOS (or if a broken version gets
Expand Down Expand Up @@ -385,12 +404,17 @@ functionality of the `MAVLink2REST` service (access via the
### Network Test
{{ service(service="Pardal", port=9120, link="/services/pardal", based=true) }}

The Network Test page measures real-time latency between BlueOS and the surface
The Local Network Test measures real-time latency between BlueOS and the surface
computer, and allows checking the upload and download speeds between them.

A plot is provided of each test, to help diagnose intermittent issues.

{{ easy_image(src="network-test", width=350) }}
{{ easy_image(src="network-test-local", width=350) }}

The Internet Speed Test allows measuring the latency and upload and download
speeds between BlueOS and its internet connection (if one is available).

{{ easy_image(src="network-test-internet", width=350) }}

{% pirate() %}
### NMEA Injector
Expand Down Expand Up @@ -467,6 +491,10 @@ excessive resources.
{{ easy_image(src="system-info-network", width=600) }}
{{ easy_image(src="system-info-kernel", width=600, class="pirate") }}
{{ easy_image(src="system-info-firmware", width=600, class="pirate") }}
{% pirate() %}
Update buttons are provided if the device is not running the latest stable versions of
the Raspberry Pi firmware or USB controller.
{% end %}
{{ easy_image(src="system-info-about", width=600) }}

{% pirate() %}
Expand Down Expand Up @@ -554,8 +582,8 @@ connected at that time, with UDP streams counting up from port `5600`

{{ simple_pirate_image(src="video-stream-example", width=400, center=true) }}

- The streams are also presented via MAVLink, so QGroundControl (>=v4.1.7) can
toggle between them without needing to know specific ports.
- By default the streams are also presented via MAVLink, so QGroundControl (>=v4.1.7)
can toggle between them without needing to know specific ports
{% pirate() %}
- It is possible to specify a stream as "thermal", which allows it to be
overlaid on another stream in some viewing applications
Expand Down
Binary file added advanced-usage/internet-dns-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added advanced-usage/internet-network-priority.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added advanced-usage/internet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added advanced-usage/network-test-internet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified advanced-usage/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified advanced-usage/version-chooser-pirate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified advanced-usage/video-stream-example-pirate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions development/bootstrap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ If you want to make use of that functionality you'll need a [DockerHub](https://

## Updating

It is [not yet possible to (nicely) update bootstrap through the BlueOS interface](https://github.com/bluerobotics/BlueOS/issues/1510). The [BlueOS Version](../../advanced-usage#blueos-version) chooser only updates the [BlueOS-core](../core) image.
BlueOS-bootstrap versions are built at the same time as BlueOS-core versions, and they get bundled together in the Raspberry Pi images that can be flashed onto an SD card to install BlueOS onto it. For official BlueOS releases it is possible to update the BlueOS-bootstrap image to match the BlueOS release through the [BlueOS Version](../../advanced-usage#blueos-version) chooser, and is the recommended process.

BlueOS-bootstrap versions are built at the same time as BlueOS-core versions, and they get bundled together in the Raspberry Pi images that can be flashed onto an SD card to install BlueOS onto it. Updating BlueOS-bootstrap without flashing an SD card is currently only possible through the [Terminal](../../advanced-usage#terminal):
Manually updating to a non-matched and/or custom bootstrap image requires using the [Terminal](../../advanced-usage#terminal):

```sh
# drop down from blueos-core into the underlying operating system:
Expand All @@ -45,8 +45,8 @@ docker container rm $CURRENT_BOOTSTRAP_CONTAINER
# specify the Docker image source (use your account if testing a change)
BOOTSTRAP_REPO=bluerobotics
BOOTSTRAP_IMAGE=blueos-bootstrap
# specify the new version to use (e.g. 1.1.0-beta.23, or master)
NEW_BOOTSTRAP_VERSION=1.1.0-beta.23
# specify the new version to use (e.g. 1.1.0-beta.27, or master)
NEW_BOOTSTRAP_VERSION=1.1.0-beta.27
# start running the new version
# (will automatically download if it's not already available locally)
docker run \
Expand Down
3 changes: 3 additions & 0 deletions development/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,9 @@ If the Extension needs a visual interface[^3], the recommended approach is to pr

To do so requires the Extension to run a HTTP server[^4], at which it must serve a `register_service` endpoint in the format of a JSON dict with the following keys:
- `"name"`
- This gets displayed in the sidebar
- A sanitised (lowercase, alphanumeric) form is used to create a named URL for convenient access
- e.g. `My Software 9000!` -> `http://blueos.local/extension/mysoftware9000`
- `"description"`
- `"icon"`
- Select one of the [Material Design Icons](https://pictogrammers.com/library/mdi/)
Expand Down
1 change: 1 addition & 0 deletions getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The web interface monitors the autopilot and other main software components. It
- On an ethernet connection you can also access BlueOS via its static IP address ([192.168.2.2](http://192.168.2.2/))
- When BlueOS is connected to the same wifi network as your device you can also connect with it using [blueos-wifi.local](http://blueos-wifi.local/)
- By default if BlueOS does not have a wifi connection configured within 5 minutes of booting, it will start its own wifi hotspot which, when connected to, allows accessing the BlueOS interface via [blueos-hotspot.local](http://blueos-hotspot.local/)
- The hotspot SSID is `BlueOS (******)`, with password `blueosap`

### Wizard

Expand Down
Binary file modified getting-started/wizard-welcome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ This covers a summary of the major changes and new features in BlueOS-1.1. Where
- RTSP output support added for MJPG and YUYV encoded streams
- MAVLink support improved
- Allows Control Station Software (e.g. QGroundControl) to configure camera settings and switch between multiple video streams
- Disabling MAVLink advertising of a video stream is now possible
- [MAVLink Endpoints](../advanced-usage/#mavlink-endpoints) (REPLACES "Endpoints")
- IP address interface now indicates the endpoint type
- Endpoints are now editable
Expand All @@ -81,10 +82,12 @@ This covers a summary of the major changes and new features in BlueOS-1.1. Where
- Settings are now persistent across boots
- [BlueOS Version](../advanced-usage/#blueos-version) (REPLACES "Version Chooser")
- New progress bar while downloading and extracting new images
- Now allows updating the [bootstrap image](../development/bootstrap)
- [System Information](../advanced-usage/#system-information)
- New "Firmware" tab, with information about the computer's firmware and bootloader
- [Network Test](../advanced-usage/#network-test)
- New graph to track upload and download performance during a test
- New tab for internet connection testing
- New graph to track upload and download performance during a local network test
- [File Browser](../advanced-usage/#file-browser)
- New shortcuts to useful parts of the file-system
- [Bag Editor](../advanced-usage/#bag-editor) `(NEW!)`
Expand All @@ -101,9 +104,11 @@ This covers a summary of the major changes and new features in BlueOS-1.1. Where
- There's now a configurable vehicle icon, name, mDNS address, and logo
- It's now possible to download the latest BlueOS system logs, and reset settings
- Pirate mode is now toggled via the happy-robot/pirate icon in the header
- Ethernet and wifi configuration are improved
- Network, ethernet, and wifi configuration are improved
- A hotspot network is now created for devices to connect to if a normal connection does not occur on boot
- Raspberry Pi 4s can now connect via USB OTG ethernet
- Network interface priority ordering is now possible
- DNS name server configuration is now available

### Device/Hardware Support
- Added basic detection and management support for:
Expand Down