Skip to content

Commit

Permalink
advanced-usage: update view and profile configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
ES-Alexander committed Dec 12, 2023
1 parent 3165933 commit a046c4d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
Binary file modified advanced-usage/edit-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 13 additions & 10 deletions advanced-usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,12 @@ The current time and date is displayed in the top right corner.
Cockpit's interface consists of a configurable widget system, with
1. [Profiles](#profiles)
- for supporting different operators and/or vehicle types
- can be added/removed, saved and loaded, and switched between in edit mode
- can be added/removed/duplicated, saved and loaded (to/from both the vehicle and the display device),
and switched between in edit mode
1. [Views](#views) (within each profile)
- for handling different operation modes / targets within a mission
- can be added/removed, saved and loaded, and dynamically switched between
- can be added/removed/duplicated, saved and loaded to/from the display device, and
dynamically switched between during operation
1. [Widgets](#widgets) (within each view)
- for advanced information display and vehicle control
- can be added/removed, placed in arbitrary locations, and resized
Expand All @@ -90,19 +92,19 @@ to connect a different control computer to a vehicle and load the familiar contr

#### 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.
Cockpit includes internal default profiles for submarine and boat use-cases. 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 between different Cockpit versions.

#### Profile Configuration

1. Open edit mode (via the [burger menu](#burger-menu)
1. 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
- Profiles can be renamed by clicking on the settings cog icon, or duplicated via the copy icon
- Additional profiles can be imported from the display device or the connected vehicle
- The set of available profiles can be stored onto the vehicle, or reset/restored to the defaults
- The "Views" list shows the views that are available within the selected profile
- Selecting one of the [default profiles](#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

Expand All @@ -125,9 +127,10 @@ Multiple simultaneous tabs from the same browser instance will be supported in f

- Open edit mode via the [burger menu](#burger-menu)
- Select a view to edit, and/or create or remove views as desired
- Views can be imported from an external file, or exported to a file for sharing
- 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
{{ easy_image(src="view-config", width=250, center=true) }}
- The "Current widgets" list allows
1. dragging the widgets in the current view to reorder which widget is on top
- This helps for use-cases like overlaying a HUD element on a video display
Expand Down
Binary file added advanced-usage/view-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a046c4d

Please sign in to comment.