Move PX4 Guide source into /docs (#24490)

* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
This commit is contained in:
Hamish Willee
2025-03-13 16:08:27 +11:00
committed by GitHub
co-authored by Ramon Roche
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
+13
View File
@@ -0,0 +1,13 @@
# Data Links
Data links are radio channels that are used to communicate vehicle telemetry (position, velocity, battery status, and so on) from the flight controller to ground control stations (and to some RC systems), and commands from ground stations to the vehicle.
These links are usually created using different radios than those used for manual RC control of the vehicle.
PX4 uses the [MAVLink](https://mavlink.io/en/) protocol for communicating serial data over the radio channel.
This section provides information about various radio systems that you can use, and how to configure them for use with PX4.
- [MAVLink Telemetry (OSD/GCS)](../peripherals/mavlink_peripherals.md) — Configuring autopilot outputs for telemetry
- [Telemetry Radios](../telemetry/index.md) — Popular protocols and radio systems for data links
- [FrSky Telemetry](../peripherals/frsky_telemetry.md) — Telemetry on your (FRSky) RC Receiver
- [TBS Crossfire (CRSF) Telemetry](../telemetry/crsf_telemetry.md) — Telemetry on your (TBS Crossfire) RC Receiver
- [Satellite Comms (Iridium/RockBlock)](../advanced_features/satcom_roadblock.md) — High-latency comms via satellite
+92
View File
@@ -0,0 +1,92 @@
# SiK Radio Integration
[SiK radio](https://github.com/LorenzMeier/SiK) is a collection of firmware and tools for telemetry radios.
Information about _using_ SiK Radio can be found in [Peripheral Hardware > Telemetry > SiK Radio](../telemetry/sik_radio.md)
The ("developer") information below explains how to build SiK firmware from source and configure it using AT commands.
## Supported Radio Hardware
The SiK repository includes bootloaders and firmware for the following telemetry radios (2020-02-25):
- HopeRF HM-TRP
- HopeRF RF50-DEMO
- RFD900
- RFD900a
- RFD900p
- RFD900pe
- RFD900u
- RFD900ue
::: info
The SiK repository does not currently firmware for RFD900x or RFD900ux telemetry radios.
In order to update firmware on these radios (for instance, in order to support MAVLink v2.0), the following process is suggested:
1. Download the appropriate firmware from the [RFDesign website](https://files.rfdesign.com.au/firmware/).
1. On a Windows PC, download and install [RFD Modem Tools](https://files.rfdesign.com.au/tools/).
1. Use the RFD Modem Tools GUI to upload the firmware to your RFD900x or RFD900ux telemetry radio.
:::
## Build Instructions
You will need to install the required 8051 compiler, as this is not included in the default PX4 Build toolchain.
### Mac OS
Install the toolchain:
```sh
brew install sdcc
```
Build the image for the standard SiK Radio / 3DR Radio:
```sh
git clone https://github.com/LorenzMeier/SiK.git
cd SiK/Firmware
make install
```
Upload it to the radio \(**change the serial port name**\):
```
tools/uploader.py --port /dev/tty.usbserial-CHANGETHIS dst/radio~hm_trp.ihx
```
## Configuration Instructions
The radio supports AT commands for configuration.
```sh
screen /dev/tty.usbserial-CHANGETHIS 57600 8N1
```
Then start command mode:
::: info
DO NOT TYPE ANYTHING ONE SECOND BEFORE AND AFTER
:::
```sh
+++
```
List the current settings:
```sh
ATI5
```
Then set the net ID, write settings and reboot radio:
```sh
ATS3=55
AT&W
ATZ
```
::: info
You might have to power-cycle the radio to connect it to the 2nd radio.
:::
+18
View File
@@ -0,0 +1,18 @@
# Telemetry Radio/Modem Integration
Telemetry Radios can (optionally) be used to provide a wireless MAVLink connection between a ground control station like _QGroundControl_ and a vehicle running PX4.
This section contains topics about advanced use of supported radios and integrating new telemetry systems into PX4.
:::tip
[Peripheral Hardware > Telemetry Radios](../telemetry/index.md) contains information about telemetry radio systems already supported by PX4.
This includes radios that use the _SiK Radio_ firmware and _3DR WiFi Telemetry Radios_.
:::
## Integrating Telemetry Systems
PX4 enables MAVLink-based telemetry via the telemetry port of a Pixhawk-based flight controller.
Provided that a telemetry radio supports MAVLink and provides a UART interface with compatible voltage levels/connector, no further integration is required.
Telemetry systems that communicate using some other protocol will need more extensive integration, potentially covering both software (e.g. device drivers) and hardware (connectors etc.).
While this has been done for specific cases (e.g. [FrSky Telemetry](../peripherals/frsky_telemetry.md) enables sending vehicle status to an RC controller via an FrSky receiver) providing general advice is difficult.
We recommend you start by [discussing with the development team](../contribute/support.md).