[BlueOS] Update docs to match latest state (1.1 / 1.2)

_index.md

@@ -1,13 +1,13 @@
 +++
 title = "BlueOS"
 description = "Documentation for the BlueOS Onboard Computer software."
-date = 2023-08-25T07:05:00+11:00
+date = 2024-04-05T00:20:00+11:00
 template = "docs/section.html"
 sort_by = "weight"
 weight = 2
 draft = false
 aliases = ['/software/onboard/BlueOS-latest', '/blueos/latest']
 
 [extra]
-document_version = "1.1"
+document_version = "1.2"
 +++

advanced-usage/index.md

@@ -1,7 +1,7 @@
 +++
 title = "Advanced Usage"
 description = "BlueOS advanced usage documentation."
-date = 2023-12-04T19:00:00+11:00
+date = 2024-04-05T01:20:00+11:00
 template = "docs/page.html"
 sort_by = "weight"
 weight = 30
@@ -12,7 +12,7 @@ aliases = ['/software/onboard/BlueOS-latest/advanced-usage', '/blueos/latest/adv
 lead = ''
 toc = true
 top = false
-link_base = "https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core"
+link_base = "https://github.com/bluerobotics/BlueOS/tree/1.2.3/core"
 +++
 
 ## General Information
@@ -149,6 +149,7 @@ skull-and-crossbones icon
    - CPU throttling
    - CPU under voltage
    - Connected wirelessly (instead of through a tether)
+   - BlueOS cannot connect to its host computer
 
 #### Sidebar
 
@@ -172,7 +173,7 @@ specifies the requirements for a service page to appear in the sidebar
    - Remove existing camera/endpoint/bridges configuration
 - 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
+  - Old logs are aggregated and compressed with GZip, and automatically deleted if the space runs out `(New in 1.2)`
 - Re-enable the [configuration wizard](../getting-started#wizard)
 
 ##### Power
@@ -367,6 +368,8 @@ endpoints for MAVLink-based services and programs to access.
 {% end %}
 {{ easy_image(src="mavlink-endpoints", width=600, class="pirate") }}
 {% pirate() %}
+- It is possible to switch from the default MAVLinkRouter to MAVP2P `(New in 1.2)`
+   - This may use more CPU, so is only recommended if your system is having frequent "GCS Heartbeat Lost" errors
 - Endpoints intended for internal BlueOS operations are configured to the
 loopback IP `127.0.0.1`
 - Server endpoints for external use are configured to the localhost IP
@@ -522,6 +525,8 @@ The Terminal provides
    - Can return to the core container using the `exit` command, or pressing `CTRL+d`
    - Can list available docker images (including extensions) with `docker image list`
    - Can list active docker containers (including extensions) with `docker ps -a`
+   - For BlueOS host computers that do not have the default user as "pi", a custom username
+     can be specified using the `-u` argument (e.g. `red-pill -u myusername`) `(New in 1.2)`
 {% end %}
 {{ easy_image(src="terminal", width=600, class="pirate") }}
 

development/core/index.md

@@ -1,7 +1,7 @@
 +++
 title = "BlueOS-core"
 description = "BlueOS-core development documentation."
-date = 2023-06-01T19:30:00+11:00
+date = 2024-04-10T01:30:00+10:00
 template = "docs/page.html"
 sort_by = "weight"
 weight = 30
@@ -37,6 +37,7 @@ The [BlueOS Version](../../advanced-usage#blueos-version) chooser can be used to
 1. [configuration](https://github.com/bluerobotics/BlueOS/tree/master/core/configuration) files that the Dockerfile moves to appropriate locations for the programs they apply to
 1. [start-blueos-core](https://github.com/bluerobotics/BlueOS/tree/master/core/start-blueos-core) script that runs when the BlueOS-core container gets started
     - Responsible for configuring and starting the services
+    - Supports disabling a comma-separated list of core services via the `BLUEOS_DISABLE_SERVICES` environment variable `(New in 1.2)`
 1. [libs](https://github.com/bluerobotics/BlueOS/tree/master/core/libs) code libraries of shared functionality available to the service backends
 1. [services code](https://github.com/bluerobotics/BlueOS/tree/master/core/services) for running [the services](#services)
     - Mostly Python backend code, often wrapped around / making use of a program installed by `tools`
@@ -73,7 +74,7 @@ The services built into BlueOS are as follows:
 | File Browser | Provides a graphical interface to the file system. | - [File Browser](../../advanced-usage/#file-browser) | - [tools/filebrowser](https://github.com/bluerobotics/BlueOS/tree/master/core/tools/filebrowser) | - [views/FileBrowserView](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/FileBrowserView.vue)<br> - [types/filebrowser.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/filebrowser.ts) |
 | [helper](https://github.com/bluerobotics/BlueOS/tree/master/core/services/helper) | Lists available webpages | - Sidebar | -- | - [types/helper.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/helper.ts) |
 | [Kraken](https://github.com/bluerobotics/BlueOS/tree/master/core/services/kraken) | Manages extensions and the extension store. | - [Extensions Manager](../../advanced-usage/#extensions-manager) | -- | - [views/ExtensionView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/ExtensionView.vue)<br>- [views/ExtensionManagerView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/ExtensionManagerView.vue)<br> - [components/kraken](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/kraken)<br> - [types/kraken.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/kraken.ts) |
-| [log_zipper](https://github.com/bluerobotics/BlueOS/tree/master/core/services/log_zipper) | Zips old log files to reduce space usage. | -- | -- | -- |
+| [log_zipper](https://github.com/bluerobotics/BlueOS/tree/master/core/services/log_zipper) | GZips old log files to reduce space usage, and deletes them if space runs out. | -- | -- | -- |
 | Log Browser | Allows browsing, downloading, and viewing autopilot log files. | - [Log Browser](../../advanced-usage/#log-browser) | - [tools/logviewer](https://github.com/bluerobotics/BlueOS/tree/master/core/tools/logviewer) | - [views/LogView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/LogView.vue)<br> - [components/logs](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/logs) |
 | MAVLink Camera Manager | Manages camera and video stream pipelines, and presents them over MAVLink.  | - [Video Streams](../../advanced-usage/#video-streams) | - [tools/ mavlink_camera_manager](https://github.com/bluerobotics/BlueOS/tree/master/core/tools/mavlink_camera_manager) | - [views/VideoManagerView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/VideoManagerView.vue)<br> - [components/video-manager](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/video-manager)<br> - [store/video.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/store/video.ts)<br> - [types/video.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/video.ts) |
 | MAVLink2Rest | A REST-based interface to the MAVLink network | - [MAVLink Inspector](../../advanced-usage/#mavlink-inspector)<br> - [Autopilot Parameters](../../advanced-usage/#autopilot-parameters)<br> - [Vehicle Setup](../../advanced-usage/#vehicle-setup) | - [tools/mavlink2rest](https://github.com/bluerobotics/BlueOS/tree/master/core/tools/mavlink2rest) | - [views/MavlinkInspectorView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/MavlinkInspectorView.vue)<br> - [components/mavlink](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/components/mavlink/)<br> - [components/mavlink-inspector](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/components/mavlink-inspector)<br> - [store/mavlink.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/store/mavlink.ts)<br> - [types/mavlink.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/mavlink.ts)<br> - [views/ParameterEditorView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/ParameterEditorView.vue)<br> - [components/parameter-editor](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/parameter-editor)<br> - [types/parameter_repository.d.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/parameter_repository.d.ts)<br> - [views/VehicleSetupView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/VehicleSetupView.vue)<br> - [components/vehiclesetup](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/vehiclesetup) |