diff --git a/docs/albatross/first-link.md b/docs/albatross/first-link.md new file mode 100644 index 00000000..76743691 --- /dev/null +++ b/docs/albatross/first-link.md @@ -0,0 +1,34 @@ +--- +title: Check your first link +sidebar_label: First link +description: Verify that the OpenHD Air and Ground units connect and deliver a live picture. +--- + +## Set up on the bench + +Connect the Air camera, the supported radios and antennas, and a display or QOpenHD client on the Ground side. Power the units with the supplies specified for your hardware. Keep the units a short distance apart and remove propellers if the equipment is already mounted on a model. + +```mermaid +flowchart LR + Camera["Air camera"] --> Air["OpenHD Air"] + Air <-->|OpenHD radio link| Ground["OpenHD Ground"] + Ground --> Display["QOpenHD display"] +``` + +## Check status and video + +1. Open QOpenHD and check Ground status first. If you are using a separate QOpenHD client, verify its connection to the Ground unit. +2. Check Air status. The Air unit should appear once its telemetry reaches Ground. +3. Move something in front of the Air camera to confirm you have a live picture. +4. If a flight controller is connected, verify that its telemetry updates independently of the picture. + +## If the check fails + +| What you see | What to check | +| --- | --- | +| QOpenHD cannot see Ground | Check Ground power, boot media, and the client connection when using an external display device. | +| Ground is visible but Air is missing | Check Air power and boot, Air and Ground role selection, both radios and antennas, and matching binding settings. If you know Air is transmitting on another channel, use the Ground frequency scan in QOpenHD. | +| Air is visible but there is no picture | Check camera compatibility and connection, the selected camera mode, and video decoding on the Ground display. | +| Video works but flight-controller telemetry is missing | Check the Air-to-flight-controller connection and the telemetry protocol and baud rate configured on both ends. | + +See [QOpenHD](./qopenhd.md) for the display controls, or [OpenHD support](/support) if you need help with a specific board and build. diff --git a/docs/albatross/img/sounds-and-speech.webp b/docs/albatross/img/sounds-and-speech.webp new file mode 100644 index 00000000..943794e1 Binary files /dev/null and b/docs/albatross/img/sounds-and-speech.webp differ diff --git a/docs/albatross/img/startup.webp b/docs/albatross/img/startup.webp new file mode 100644 index 00000000..09cbd75f Binary files /dev/null and b/docs/albatross/img/startup.webp differ diff --git a/docs/albatross/index.md b/docs/albatross/index.md new file mode 100644 index 00000000..a91ddcee --- /dev/null +++ b/docs/albatross/index.md @@ -0,0 +1,20 @@ +--- +title: OpenHD 3.0 Albatross +sidebar_label: Overview +slug: /albatross +description: Start here for OpenHD 3.0 Albatross installation, bench setup, and QOpenHD. +--- + +![Metallic albatross with the OpenHD 3.0 Albatross title](./img/startup.webp) + +Albatross is the OpenHD 3.0 beta series. An **Air** unit sends video from the camera over the OpenHD link. A **Ground** unit receives the stream and can display video and telemetry in QOpenHD. + +## Start here + +1. [Install Albatross](./installation.md) on your Air and Ground units. +2. [Check your first link](./first-link.md) on the bench before installing the Air unit on a model. +3. [Get to know QOpenHD](./qopenhd.md) for link status, the on-screen display, and audio settings. + +:::note Beta builds +Image availability depends on the board and its role. Check the build you plan to install for your exact hardware. Keep your working boot media and back up any recordings and settings before trying a beta. +::: diff --git a/docs/albatross/installation.md b/docs/albatross/installation.md new file mode 100644 index 00000000..6414ec1b --- /dev/null +++ b/docs/albatross/installation.md @@ -0,0 +1,33 @@ +--- +title: Install Albatross +sidebar_label: Installation +description: Select, write, and boot OpenHD 3.0 Albatross images for Air and Ground. +--- + +## Choose your images + +Use [OpenHD ImageWriter](/downloads) on your computer. In the image selector, choose the hardware family and exact board for each unit. Look for **OpenHD 3.0** in the release name. Image labels may use the spelling `3.0-albatros-beta…`. + +Choose the appropriate **Air** or **Ground** image when the catalog lists the roles separately. If the image supports both roles and ImageWriter asks you to configure one, select **Air** for the camera side and **Ground** for the receiver. + +:::tip +If the Albatross build for your board is distributed separately, use ImageWriter's custom image option with the board-specific image. Follow the matching recovery or installation instructions for hardware with internal storage. +::: + +## Write the boot media + +1. Back up the target media. Writing an image erases its contents. +2. Select the storage device and confirm its capacity and identity before writing. +3. Apply any role or camera options offered for the selected image. If you set a binding phrase, use the same phrase on both sides. +4. Write and verify the image, then eject the device. Repeat for the other unit and label both boot media so you can identify Air and Ground later. + +```mermaid +flowchart LR + A["Select board and Albatross build"] --> B["Confirm Air or Ground role"] + B --> C["Select target storage"] + C --> D["Write and verify"] +``` + +## First boot + +Insert the written media into each matching board. Boot the Ground unit and open QOpenHD on a compatible display or client, then boot the Air unit with its camera and antennas attached. Allow the first boot to finish before running the [bench checks](./first-link.md). diff --git a/docs/albatross/qopenhd.md b/docs/albatross/qopenhd.md new file mode 100644 index 00000000..891c13c6 --- /dev/null +++ b/docs/albatross/qopenhd.md @@ -0,0 +1,19 @@ +--- +title: QOpenHD on Albatross +sidebar_label: QOpenHD +description: Use the QOpenHD display, link status, and sound and speech controls. +--- + +QOpenHD displays the live camera stream and overlays information from the OpenHD link and your flight controller. Available settings depend on your QOpenHD build and device. + +## Video and link status + +Open the on-screen sidebar using its chevron. Use the link controls to check Ground and Air status. If you're diagnosing a connection, start with the [first-link checklist](./first-link.md) before changing radio settings. + +## Sounds and speech + +In **Sounds & Speech**, you can configure the startup sound, warning sounds, and voice announcements independently. Select a speech language and use **Test voice** to check that your operating system has a voice for that language. **Test sound** checks the local warning sound. Use **Voice Rules** to review the events that trigger spoken announcements. + +![QOpenHD Sounds and Speech panel with welcome and warning sound toggles, speech language, volume, and test buttons](./img/sounds-and-speech.webp) + +*QOpenHD development build on Windows. Controls can vary by build and platform.* diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 19f4e64a..b262a0a4 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -358,6 +358,17 @@ const config: Config = { position: 'left', label: 'Documentation', }, + { + type: 'dropdown', + label: 'Albatross', + position: 'left', + items: [ + {to: '/albatross', label: 'Overview', exact: true}, + {to: '/albatross/installation', label: 'Installation'}, + {to: '/albatross/first-link', label: 'First link'}, + {to: '/albatross/qopenhd', label: 'QOpenHD'}, + ], + }, { to: '/downloads', label: 'Downloads', diff --git a/sidebars.ts b/sidebars.ts index 41031b0d..166988a7 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -13,6 +13,12 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; Create as many sidebars as you want. */ const sidebars: SidebarsConfig = { + albatrossSidebar: [ + 'albatross/index', + 'albatross/installation', + 'albatross/first-link', + 'albatross/qopenhd', + ], tutorialSidebar: [ 'introduction', 'installation-guide',