transfer initial content

content/_index.md

@@ -0,0 +1,7 @@
++++
+title = "Docs"
+description = "Cockpit documentation."
+sort_by = "weight"
+weight = 1
+template = "docs/section.html"
++++

content/usage/_index.md

@@ -0,0 +1,11 @@
++++
+title = "Cockpit"
+description = "Usage documentation for the Cockpit Control Station Software."
+template = "docs/section.html"
+sort_by = "weight"
+weight = 1
+draft = false
+
+[extra]
+document_version = "1.x"
++++

content/usage/getting-started/index.md

@@ -0,0 +1,63 @@
++++
+title = "Getting Started"
+description = "Cockpit getting started instructions."
+date = 2023-12-12T22:20:00+11:00
+template = "docs/page.html"
+sort_by = "weight"
+weight = 20
+draft = false
+
+[extra]
+lead = ''
+toc = true
+top = false
++++
+## General Configuration
+
+When run as a BlueOS Extension, Cockpit will automatically be configured to connect using the IP address of the connection to BlueOS.
+
+If that address changes during operating (or if Cockpit is run as a standalone application) it may be necessary to configure the
+global vehicle address, MAVLink2REST address, and WebRTC signalling server address so that Cockpit knows the correct connection 
+points for the vehicle. After address configuration it is necessary to refresh the page.
+
+To access the configuration section, open the burger menu in the top left, and select "Configuration".
+
+{{ easy_image(src="general-config", width=500, center=true) }}
+
+## Interface Setup
+
+### Visual Display
+By default, the interface of Cockpit is set up with three [views](../advanced/#views):
+1. Video view
+    - Includes a video stream, vehicle telemetry, compass and attitude instrument indicators, status updates, and flight mode selection
+    - Useful for first-person control of a vehicle like an ROV, copter, or plane, focused on what the vehicle can see
+
+{{ easy_image(src="video-view", width=600, center=true) }}
+
+2. HUD view
+    - Includes a video stream, vehicle telemetry, heads-up display (HUD) overlay elements, status updates, and flight mode selection
+    - An alternative for first-person control of a vehicle like an ROV, copter, or plane, focused on precision maneuvering
+
+{{ easy_image(src="hud-view", width=600, center=true) }}
+
+3. Map view
+    - Includes a map, vehicle telemetry, status updates, and flight mode selection
+    - Most useful for mission planning and remote monitoring of vehicles with a positioning system and/or autonomous control
+
+{{ easy_image(src="map-view", width=600, center=true) }}
+
+The available views and the widgets within them (including sizing and placement) can be configured as described in the
+[advanced usage documentation](../advanced/#edit-mode).
+
+### Joystick Configuration
+For vehicles controlled via a joystick, button and axis mappings can be set by clicking the burger menu (top left), then selecting
+"Configuration" and navigating to the Joystick tab.
+
+{{ easy_image(src="joystick-config", width=500, center=true) }}
+
+## Vehicle Setup
+
+Cockpit does not currently contain vehicle configuration or calibration functionalities. It is recommended to perform these in advance,
+using either the BlueOS web interface and/or an alternative control station software like QGroundControl.
+
+It is possible to switch between Mission Planning and Flight displays via the burger menu in the top left.

content/usage/installation.md

@@ -0,0 +1,31 @@
++++
+title = "Installation"
+description = "Cockpit installation instructions."
+date = 2023-08-25T12:00:00+11:00
+template = "docs/page.html"
+sort_by = "weight"
+weight = 10
+draft = false
+
+[extra]
+toc = true
+top = false
++++
+
+## BlueOS Extension
+
+For vehicles with an [Onboard Computer](https://blueos.cloud/docs/hardware/required/onboard-computer/index.md) running [BlueOS](https://blueos.cloud/docs/blueos),
+and an IP-based (wifi / ethernet tether) connection to the [Control Station Computer](https://blueos.cloud/docs/hardware/required/control-computer/index.md),
+Cockpit [is available](https://docs.bluerobotics.com/BlueOS-Extensions-Repository/#:~:text=Cockpit,-Maintainer)
+as a [BlueOS Extension](https://blueos.cloud/docs/blueos/latest/extensions).
+
+### Updates
+
+Once installed, updating to a new Cockpit version can be done via the "Installed" tab of the BlueOS
+[Extensions Manager](https://blueos.cloud/docs/blueos/latest/advanced-usage/#extensions-manager).
+
+
+## Self-Contained Application
+
+In future, Cockpit will also be available as a self-contained Electron application, which can be stored on a Control Station
+Computer and started up for connection to a vehicle.

content/usage/overview/index.md

@@ -0,0 +1,55 @@
++++
+title = "Overview"
+description = "Cockpit overview."
+date = 2024-09-03T04:30:00+10:00
+template = "docs/page.html"
+sort_by = "weight"
+weight = 0
+draft = false
+
+[extra]
+lead = 'Cockpit is an intuitive and customizable cross-platform control station software for remote vehicles of all types.'
+toc = true
+top = false
++++
+
+{{ easy_image(src="cockpit-banner", width=460, center=true) }}
+
+{{ easy_image(src="interface-highlight", width=650, center=true) }}
+
+## 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](https://docs.bluerobotics.com/BlueOS-Extensions-Repository#:~:text=Cockpit,-Maintainer) (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](https://github.com/bluerobotics/cockpit),
+under [two possible licenses](https://github.com/bluerobotics/cockpit/tree/master/LICENSE.md).
+
+## Primary Feature List
+
+- Browser-based control station software, for vehicle control and monitoring from any web-capable device
+- Widget-based layout system, with freeform positioning and resizing
+- Custom display [Views](../advanced/#views), for interface pages/profiles that can be switched between
+    - Different browser windows/screens/devices can independently select which view to display
+    - Views are downloadable and can be shared (json contains name and list of components and widget settings)
+- MAVLink `NAMED_VALUE_FLOAT`/`_INT` messages are self-registering for use in [mini-widgets](../advanced/#mini-widgets) (including custom ones!)
+- WebRTC-based [video widget](../advanced/#video)
+    - Multiple widgets can be added to support arbitrary numbers of video streams
+    - Includes video recording support, on the display device
+- [Map widget](../advanced/#map)
+    - Provides position tracking
+    - Allows planning (and saving/loading) autonomous missions
+    - Allows mission control
+    - In future will allow setting the current vehicle position, and clicking to guide the vehicle to new positions
+- Customisable Actions mappable to user inputs (e.g. joysticks, and key presses / screen clicks in future)
+    - Actions can send commands to the vehicle, or can trigger local events like view switching and starting video recording
+    - Includes support for simultaneous input from multiple sources (including multiple joysticks)
+- [Joysticks](../advanced/#joysticks) of _any_ type can be configured
+    - Buttons and axes can be mapped to arbitrary Actions
+- [Notification system](../advanced/#alerts)
+    - Displays autopilot (MAVLink `STATUSTEXT`) and application alerts
+    - Includes text to speech announcements
+- [Mission naming](../advanced/#mission-name) used on the interface and video save filenames