Skip to content

Commit f39e0f6

Browse files
committed
content: usage: advanced: cover data-lake
1 parent c49f51b commit f39e0f6

4 files changed

Lines changed: 23 additions & 11 deletions

File tree

313 KB
Loading
273 KB
Loading
1 MB
Loading

content/usage/advanced/index.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,9 @@ the cause of the problem:
527527

528528
{{ easy_image(src="video-widget-stats", width=170, center=true) }}
529529

530+
These statistics are also available through the [data-lake](#data-lake), and can be [plotted](#data-plotting)
531+
for monitoring/analysis outside of the video widget if desired.
532+
530533
##### WebRTC Video Recorder
531534
It is possible to directly record an incoming WebRTC video stream (not the scaled and cropped/flipped/rotated
532535
display of the widget):
@@ -651,27 +654,20 @@ self-replacing mjpeg like from an ESP32-Cam. It could also display images hosted
651654
The plotter widget allows plotting data on a graph:
652655
{{ easy_image(src="plotter-widget", width=300, center=true) }}
653656

654-
Configuration options are provided for selecting the variables to plot, and modifying basic appearance
655-
characteristics:
657+
Configuration options are provided for selecting the [data-lake variable](#data-lake) to plot, and
658+
modifying basic appearance characteristics:
656659
{{ easy_image(src="plotter-config", width=450, center=true) }}
657660

658661
It is possible to change the decimal resolution of the displayed statistics, and the limit the number
659662
of plotted samples to improve visibility and performance.
660663

661-
{% note() %}
662-
The data lake which the widget gets its data from by default provides access to the Cockpit memory
663-
usage, MAVLink message fields, and values added from [Custom Actions](#custom-actions). It will soon be
664-
connected to the BlueOS-specific options available to
665-
[Very Generic Indicators](#very-generic-indicators) as well.
666-
{% end %}
667-
668664
#### Do It Yourself Widget
669665

670666
- Completely custom elements, code logic, and styling
671667
{{ easy_image(src="diy-widget-config", width=550, center=true) }}
672668
- Runs code automatically when Cockpit starts/refreshes
673-
- Can listen to, create, and modify data lake variables, and register and/or execute Actions using the
674-
Cockpit API (`window.cockpit.*`)
669+
- Can listen to, create, and modify [data-lake variables](#data-lake), and register and/or execute Actions
670+
using the Cockpit API (`window.cockpit.*`)
675671
- Can be exported to or imported from a JSON file with `"html"`, `"css"`, and `"js"` string fields
676672

677673
#### Container Widgets
@@ -761,6 +757,17 @@ as the router](https://blueos.cloud/docs/latest/usage/advanced/#mavlink-endpoint
761757
interface provided.
762758
{% end %}
763759

760+
### Data Lake
761+
762+
- Internal data management and storage system
763+
- Includes information about Cockpit, the vehicle, video streams, MAVLink telemetry, and widget and Action internals
764+
{{ easy_image(src="data-lake-overview", width=600, center=true) }}
765+
- Supports defining custom variables:
766+
- These can be [set using joystick buttons](#data-lake-variables)
767+
{{ easy_image(src="data-lake-custom-variable", width=450, center=true) }}
768+
- Allows defining compound variables, which are computations based on and/or combining other variables:
769+
{{ easy_image(src="data-lake-compound-variable", width=450, center=true) }}
770+
764771
## Behaviour Configuration
765772

766773
Cockpit's behaviour can be configured via the [sidebar menu](#sidebar-menu), with the following tabs:
@@ -881,6 +888,11 @@ Joystick buttons can also be configured to run more general functionalities, lik
881888
sending a single MAVLink message. These options can be provided (or defined) using
882889
[Cockpit's Action system](#cockpit-actions-1).
883890

891+
##### Data Lake Variables
892+
893+
When it is useful for the button state to represent a value within some other functionality, the button can
894+
be configured to control a variable within Cockpit's [data-lake system](#data-lake).
895+
884896
##### Modifier Keys
885897

886898
Modifiers allow sacrificing one button in order to add an extra functionality slot for every non-modifier button.

0 commit comments

Comments
 (0)