On this page
-On this page
-
+
- Profiles
+
+
-
+
+
- Default Profiles + + + +
- Profile Configuration + + + +
+
- Views
-
@@ -323,21 +339,25 @@
- Attitude HUD +
- Virtual Horizon +
- Compass
- Compass HUD
- Depth HUD -
- Indicators +
- IFrame
- Image Viewer
- Map -
- Video +
- Video Player -
- Mini Widget Container +
- URL Video Player + +
- Mini Widget Bar
On this page
Alerts
Some alerts can be read aloud on arrival using text to speech technology, which can be configured.
-Mini Widget Containers
+Mini Widget Container
When space is available, mini widgets can be placed on the right side of the alerts display.
Date
The current time and date is displayed in the top right corner.
Edit Mode
-Cockpit's interface is designed around a configurable widget system, within an arbitrary set of views. -Widgets can be added/removed, placed in arbitrary locations, and resized.
+Cockpit's interface consists of a configurable widget system, with
+-
+
- Profiles
+
-
+
- for supporting different operators and/or vehicle types +
- can be added/removed, saved and loaded, and switched between in edit mode +
+ - Views (within each profile)
+
-
+
- for handling different operation modes / targets within a mission +
- can be added/removed, saved and loaded, and dynamically switched between +
+ - Widgets (within each view)
+
-
+
- for advanced information display and vehicle control +
- can be added/removed, placed in arbitrary locations, and resized +
+ - Mini-widgets (within mini-widget bar widgets)
+
-
+
- for basic information display and vehicle/interface control +
- can be added/removed, reordered within widget bars, and moved between them +
+
+
Profiles
+A "profile" is a collection of views that are relevant to a particular use-case or operator.
+If one control station computer is used by multiple operators (e.g. within the same organisation) +at different times then it could be useful for each operator to have their preferred interface saved on +that computer, and they can switch to their profile when they open up Cockpit.
+Alternatively, if the same control station computer is used to control different types of vehicles +(e.g. a boat, an underwater ROV, and a drone) then the operator can load the appropriate vehicle control +interface when they connect to a different vehicle type. It will soon be possible to store and load +profiles from the vehicle itself, instead of only on the control station computer, which makes it easier +to connect a different control computer to a vehicle and load the familiar control profiles for that vehicle.
+Default Profiles
+Cockpit includes default profiles for submarine and boat use-cases, which cannot be edited. These serve as +a reference for a recommended base profile, and are useful for restoring to a known reasonable interface in +case something goes wrong with custom interface options. The default profiles are not persistent, so they +may change through different Cockpit versions.
+Profile Configuration
+-
+
- Open edit mode (via the burger menu +
- Select a custom/user profile to edit, and/or create, import, or remove profiles as desired
+
-
+
- Non-default profiles can be renamed by clicking on the settings cog icon +
- The "Views" list shows the views that are available within the selected profile +
- Selecting one of the default profiles will restore the interface to a standard one, +but cannot be edited unless you download and upload it as a user profile +
+
Views
A "view" is like a page that widgets can be displayed in. It is possible to configure multiple separate views and switch between them during operation, which is useful if you have different interface @@ -425,8 +497,6 @@
Views
As an example, you may have one view tailored to general navigation, and another that's designed around inspections. The first view could then be used while getting the vehicle to the inspection site, and then the second view can be switched to once it's time to actually perform the inspection.
-If a vehicle is not always controlled through the same control station computer/device then it may be useful -to configure different views for the best control experience with each device.
It is possible for different devices or browser instances to access Cockpit at the same time (e.g. using separate browser profiles, or one display in incognito mode, but currently not multiple tabs of the same browser instance), with their views configured independently. To use the same component layouts across @@ -437,6 +507,8 @@
Configuration
- Open edit mode via the burger menu
- Select a view to edit, and/or create or remove views as desired
-
+
- Clicking on the cog settings icon allows renaming a view, and determining whether the bottom +bottom mini-widgets bar is shown or hidden/docked when Cockpit boots
- Views can be imported from an external file, or exported to a file for sharing
@@ -455,13 +527,14 @@ - Clicking on a regular widget adds it to the view, after which it can be positioned and resized as desired
- Mini widgets have fixed sizes, but can be dragged and dropped into the desired location in the header/footer -bars or in a mini widget container +bars or in a custom mini widget bar +
- The selector in the bottom left can be used to choose between editing regular or mini widgets
- Some regular widgets can be configured, by clicking the three dots in the top right corner of the widget -
- Mini widgets that support configuration can be clicked on anywhere on the widget to open the configuration options +
- Some widgets can be configured, by clicking the cog settings icon in the "Current widgets" list
-
-
- This is currently only possible during operation, not while in edit mode +
- There are currently cog icons for all widgets, +so if you click a cog icon and nothing happens it means that widget is not configurable
Configuration
Attitude HUD
Virtual Horizon
+The virtual horizon widget displays the vehicle's pitch and roll as though on the gauge in a plane:
+
+It is most useful for guided and/or autonomous control, where the main display is of the vehicle's position.
Compass
The compass widget displays the vehicle's orientation as though looking at a compass in your hand:
Compass HUD
It is possible to configure whether the exact heading angle is shown, and the colour of the lines:
+It is possible to configure whether the exact heading angle is shown, whether to use a -180 to +180° range +(default is 0 to 360°), and the colour of the lines:
Depth HUD
Indicators
-The indicators widget shows a collection of telemetry values, including the vehicle's attitude, GPS location, -and optionally its power supply and usage and some debugging data:
+IFrame
+The iframe widget provides an inline frame that can display another HTML page within the Cockpit interface. +This is particularly useful for showing the interfaces and displays of BlueOS Extensions (e.g. for a sonar viewer):
+
Configuration determines the URL to fetch the page from, as well as the overall transparency of the iframe:
+
Image Viewer
The image viewer widget shows an image that is accessible to the control station computer via its network.
@@ -551,8 +632,8 @@Map
In future it will be possible to set the current vehicle position, and click to guide the vehicle to new positions.
-Video
-The video widget displays an available WebRTC video stream. BlueOS uses the +
Video Player
+The video player widget displays an available WebRTC video stream. BlueOS uses the MAVLink Camera Manager to automatically create a WebRTC stream for applicable video streams.
Video
Video recording is possible using a mini widget.
-Mini Widget Container
-The mini widget container widget is a rectangular container for storing mini widgets.
+It is also possible to select the video source IP, which is recommended especially if there are multiple +available connection routes (e.g. if there is a wired route through a tether, as well as a wireless connection, +you should select the tether IP and remove the wireless one to avoid video stuttering from transmission over wifi).
+Video recording is possible using a mini widget, and directly records the incoming stream +(not the scaled and cropped display of the widget).
+URL Video Player
+The URL video player widget displays a video from a URL. This is useful for testing IP cameras that are not +being redirected via BlueOS, but can also be used to display online videos if that is for some reason relevant.
+
+Configuration allows selecting which URL to stream a video from, as well as options for whether to play the +video automatically, whether it should loop when complete, whether it should play sound or be muted, whether +playback controls should be exposed, and choosing how the video frames should fit within the widget (as +described in Video Player.
+
+Mini Widget Bar
+The mini widget bar widget is a rectangular container for storing mini widgets.
+
Mini Widgets
Mini widgets are small, generally single-function widgets that can be drag-positioned in the -header bar, footer bar, or any mini widget container.
+header bar, footer bar, or any mini widget bar. +They are editable by selecting "Mini Widgets" in the bottom left corner of edit mode, then either +dragging a new mini-widget (from those available along the bottom of the screen) into a +mini-widget bar, or configuring or removing one from the "current mini-widgets" +list in the bottom left corner.
The current options include
- Arm/Disarm toggle switch
- Vehicle connection status indicator
- Power / battery indicator
- Depth indicator +
- (Relative) altitude indicator
- Very generic indicator
-
-
- clicking on this allows selecting which vehicle variable to track, out of +
- configuring this allows selecting which vehicle variable to track, out of any that have been received so far (including custom ones) -
- only variables comming from Ardupilot vehicles are currently supported +
- only variables coming from Ardupilot vehicles are currently supported
- available variables include those comming from
NAMED_VALUE_FLOAT/INTmessages as well as any variable that is inside any MAVLink message
- - several pre-made templates are available for usage with common variables +
- several pre-made presets are available for usage with common variables
- it is also possible to specify a display unit, a value multiplier, an icon, the number of digits after the decimal place and a custom display name
+
+
- Video recorder
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/indicators-config.png b/software/control-station/Cockpit-0.0/advanced-usage/indicators-config.png
deleted file mode 100644
index 2721c3b..0000000
Binary files a/software/control-station/Cockpit-0.0/advanced-usage/indicators-config.png and /dev/null differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/indicators-widget.png b/software/control-station/Cockpit-0.0/advanced-usage/indicators-widget.png
deleted file mode 100644
index c9a0ef9..0000000
Binary files a/software/control-station/Cockpit-0.0/advanced-usage/indicators-widget.png and /dev/null differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/mini-widget-container-widget.png b/software/control-station/Cockpit-0.0/advanced-usage/mini-widget-container-widget.png
deleted file mode 100644
index a0d9686..0000000
Binary files a/software/control-station/Cockpit-0.0/advanced-usage/mini-widget-container-widget.png and /dev/null differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/mini-widgets-bar-widget.png b/software/control-station/Cockpit-0.0/advanced-usage/mini-widgets-bar-widget.png
new file mode 100644
index 0000000..516c601
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/mini-widgets-bar-widget.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/named-value-mini-widget-config.png b/software/control-station/Cockpit-0.0/advanced-usage/named-value-mini-widget-config.png
deleted file mode 100644
index b2d8d74..0000000
Binary files a/software/control-station/Cockpit-0.0/advanced-usage/named-value-mini-widget-config.png and /dev/null differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/url-video-config.png b/software/control-station/Cockpit-0.0/advanced-usage/url-video-config.png
new file mode 100644
index 0000000..a049089
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/url-video-config.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/url-video-widget.png b/software/control-station/Cockpit-0.0/advanced-usage/url-video-widget.png
new file mode 100644
index 0000000..2ef2b83
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/url-video-widget.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-custom.png b/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-custom.png
new file mode 100644
index 0000000..8e73743
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-custom.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-presets.png b/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-presets.png
new file mode 100644
index 0000000..7b6bd91
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/very-generic-widget-config-presets.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/video-config.png b/software/control-station/Cockpit-0.0/advanced-usage/video-config.png
index aa9f7e0..f64380e 100644
Binary files a/software/control-station/Cockpit-0.0/advanced-usage/video-config.png and b/software/control-station/Cockpit-0.0/advanced-usage/video-config.png differ
diff --git a/software/control-station/Cockpit-0.0/advanced-usage/virtual-horizon-widget.png b/software/control-station/Cockpit-0.0/advanced-usage/virtual-horizon-widget.png
new file mode 100644
index 0000000..694ac41
Binary files /dev/null and b/software/control-station/Cockpit-0.0/advanced-usage/virtual-horizon-widget.png differ
diff --git a/software/control-station/Cockpit-0.0/overview/cockpit-banner.png b/software/control-station/Cockpit-0.0/overview/cockpit-banner.png
new file mode 100644
index 0000000..3aa6a9e
Binary files /dev/null and b/software/control-station/Cockpit-0.0/overview/cockpit-banner.png differ
diff --git a/software/control-station/Cockpit-0.0/overview/index.html b/software/control-station/Cockpit-0.0/overview/index.html
index 8c9ea86..6815af8 100644
--- a/software/control-station/Cockpit-0.0/overview/index.html
+++ b/software/control-station/Cockpit-0.0/overview/index.html
@@ -278,12 +278,17 @@
On this page
Overview
Cockpit is an intuitive and customizable cross-platform control station software for remote vehicles of all types.
++
+
A bit of context...
The existing market for control station software is missing an option that's readily available, easy to use, versatile, easy to customise and develop for, and cross-platform. In response to this need, and fueled by years of inspirations for what a truly great control station could be, Cockpit is Blue Robotics' next-generation control interface, for thrusting your vehicle control experience into the future.
Availability
Cockpit is currently publicly available as a BlueOS Extension (requires BlueOS >= 1.1). It is still in an initial development phase, and will not be actively supported until it is officially released.
+The source code is available on GitHub, +under two possible licenses.
Primary Feature List
- Browser-based control station software, for vehicle control and monitoring from any web-capable device