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>
2026-05-30 18:06:39 +08:00 · 2025-03-13 16:08:27 +11:00
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
@@ -0,0 +1,64 @@
+# Rotoye Batmon
+
+[Rotoye Batmon](https://rotoye.com/batmon/) is a kit for adding smart battery functionality to off-the-shelf Lithium-Ion and LiPo batteries.
+It can be purchased as a standalone unit or as part of a factory-assembled smart-battery.
+
+::: info
+At time of writing you can only use Batmon by [building a custom branch of PX4](#build-px4-firmware).
+Support in the codeline is pending [PR approval](https://github.com/PX4/PX4-Autopilot/pull/16723).
+:::
+
+
+![Rotoye Batmon Board](../../assets/hardware/smart_batteries/rotoye_batmon/smart-battery-rotoye.jpg)
+
+![Pre-assembled Rotoye smart battery](../../assets/hardware/smart_batteries/rotoye_batmon/smart-battery-rotoye-pack.jpg)
+
+
+## Where to Buy
+
+[Rotoye Store](https://rotoye.com/batmon/): Batmon kits, custom smart-batteries, and accessories
+
+
+## Wiring/Connections
+
+The Rotoye Batmon system uses an XT-90 battery connector with I2C pins, and an opti-isolator board to transmit data.
+
+![Board connections](../../assets/hardware/smart_batteries/rotoye_batmon/smart-battery-rotoye-connection.png)
+
+More details can be found [here](https://github.com/rotoye/batmon_reader)
+
+
+## Software Setup
+
+### Build PX4 Firmware
+
+1. Clone or download [Rotoye's fork of PX4:](https://github.com/rotoye/PX4-Autopilot/tree/batmon_4.03)
+   ```sh
+   git clone https://github.com/rotoye/PX4-Autopilot.git
+   cd PX4-Autopilot
+   ```
+1. Checkout the *batmon_4.03* branch
+   ```sh
+   git fetch origin batmon_4.03
+   git checkout batmon_4.03
+   ```
+1. [Build and upload the firmware](../dev_setup/building_px4.md) for your target board
+
+### Configure Parameters
+
+In *QGroundControl*:
+1. Set the following [parameters](../advanced_config/parameters.md):
+   - `BATx_SOURCE` to `External`,
+   - `SENS_EN_BAT` to `true`, 
+   - `BAT_SMBUS_MODEL` to `3:Rotoye`
+1. Open the [MAVLink Console](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/analyze_view/mavlink_console.html)
+1. Start the [batt_smbus driver](../modules/modules_driver.md) in the console.
+   For example, to run two BatMons on the same bus:
+   ```sh 
+   batt_smbus start -X -b 1 -a 11 # External bus 1, address 0x0b  
+   batt_smbus start -X -b 1 -a 12 # External bus 1, address 0x0c
+   ```
+
+## Further Information
+
+[Quick Start Guide](https://rotoye.com/batmon-tutorial/) (Rotoye)