diff --git a/development/core/index.md b/development/core/index.md index def0fde..2d657e1 100644 --- a/development/core/index.md +++ b/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)
- [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)
- [views/ExtensionManagerView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/ExtensionManagerView.vue)
- [components/kraken](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/kraken)
- [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) | Zips 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)
- [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)
- [components/video-manager](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/video-manager)
- [store/video.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/store/video.ts)
- [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)
- [Autopilot Parameters](../../advanced-usage/#autopilot-parameters)
- [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)
- [components/mavlink](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/components/mavlink/)
- [components/mavlink-inspector](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/components/mavlink-inspector)
- [store/mavlink.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/store/mavlink.ts)
- [types/mavlink.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/mavlink.ts)
- [views/ParameterEditorView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/ParameterEditorView.vue)
- [components/parameter-editor](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/parameter-editor)
- [types/parameter_repository.d.ts](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/types/parameter_repository.d.ts)
- [views/VehicleSetupView.vue](https://github.com/bluerobotics/BlueOS/blob/master/core/frontend/src/views/VehicleSetupView.vue)
- [components/vehiclesetup](https://github.com/bluerobotics/BlueOS/tree/master/core/frontend/src/components/vehiclesetup) |