docs: add autogenerated link to clever firmware + small fixes

2026-05-26 11:43:25 +00:00 · 2019-05-25 14:34:29 +03:00
parent ee1a493636
commit c0217d8aff
7 changed files with 74 additions and 31 deletions
--- a/docs/ru/SUMMARY.md
+++ b/docs/ru/SUMMARY.md
@@ -17,7 +17,7 @@
 * Настройка
  * [Первоначальная настройка](setup.md)
  * [Полетные режимы](modes.md)
-  * [Прошивка Pixhawk/Pixracer](firmware.md)
+  * [Прошивка полетного контролера](firmware.md)
  * [Параметры PX4](px4_parameters.md)
  * [Настройка PID](calibratePID.md)
 * Работа с Raspberry Pi
@@ -29,13 +29,13 @@
  * [Настройка сети RPi](network.md)
  * [Работа с QGroundControl через Wi-Fi](gcs_bridge.md)
  * [Пилотирование со смартфона](rc.md)
-  * [Интерфейс UART](uart.md)
  * [Просмотр видеострима с камер](web_video_server.md)
  * [Системы координат](frames.md)
+  * [Интерфейс UART](uart.md)
 * Программирование
  * [ROS](ros.md)
  * [MAVROS](mavros.md)
-  * [Автономный полет в OFFBOARD](simple_offboard.md)
+  * [Автономный полет (OFFBOARD)](simple_offboard.md)
  * Визуальные маркеры (ArUco)
    * [Общая информация](aruco.md)
    * [Распознавание маркеров](aruco_marker.md)
--- a/docs/ru/aruco_map.md
+++ b/docs/ru/aruco_map.md
@@ -2,6 +2,10 @@

 > **Info** Для распознавания маркеров модуль камеры должен быть корректно подключен и [сконфигурирован](camera.md).

+<!-- -->
+
+> **Hint** Рекомендуется использование [специальной сборки PX4 для Клевера](firmware.md#прошивка-для-клевера).
+
 Модуль `aruco_map` распознает карты ArUco-маркеров, как единое целое. Также возможна навигация по картам ArUco-маркеров с использованием механизма Vision Position Estimate (VPE).

 ## Конфигурирование
--- a/docs/ru/firmware.md
+++ b/docs/ru/firmware.md
@@ -1,20 +1,50 @@
-Прошивка Pixhawk / Pixracer
+Прошивка полетного контроллера
 ===

 Pixhawk или Pixracer можно прошить, используя QGroundControl или утилиты командной строки.

-Различные варианты сборок стабильных прошивок PX4 можно скачать в разделе [Releases на GitHub](https://github.com/PX4/Firmware/releases).
+Прошивка для Клевера
+---

-В названии файла прошивки кодируется информации о целевой плате и варианте сборки. Примеры:
+Для Клевера рекомендуется использование специальной сборки PX4, которая содержит необходимые исправления и более подходящие параметры по умолчанию. Используйте последний стабильный релиз в [GitHub-репозитории](https://github.com/CopterExpress/Firmware/releases), содержащий слово `clever`, например `v1.8.2-clever.4`.

-* `px4fmu-v2_default.px4` — прошивка для Pixhawk с EKF2.
-* `px4fmu-v2_lpe.px4` — прошивка для Pixhawk с LPE.
-* `px4fmu-v4_default.px4` — прошивка для Pixracer с EKF2 и LPE (*Клевер 3*).
-* `px4fmu-v3_default.px4` — прошивка для более новых версий Pixhawk (чип ревизии 3, см. илл. + Bootloader v5) с EKF2 и LPE.
+<div id="release" style="display:none">
+<p>Последний стабильный релиз: <strong><a id="download-latest-release"></a></strong>.</p>

-![STM revision](../assets/stmrev.jpg)
+<ul>
+<li>Скачать файл прошивки для Pixracer (<strong>Клевер 4 / Клевер 3</strong>) – <a id="firmware-pixracer" href=""><code>px4fmu-v4_default.px4</code></a>.</li>
+<li>Скачать файл прошивки для Pixhawk (<strong>Клевер 2</strong>) – <a id="firmware-pixhawk" href=""><code>px4fmu-v2_lpe.px4</code></a>.</li>
+</ul>
+</div>

-> **Note** Для загрузки `px4fmu-v3_default.px4` может понадобиться использование команды `force_upload` из командной строки.
+<script type="text/javascript">
+    // get latest release from GitHub
+    fetch('https://api.github.com/repos/CopterExpress/Firmware/releases').then(function(res) {
+        return res.json();
+    }).then(function(data) {
+        // look for stable release
+        let stable;
+        for (let release of data) {
+            let clever = release.name.indexOf('clever') != -1;
+            if (clever && !release.prerelease && !release.draft) {
+                stable = release;
+                break;
+            }
+        }
+        let el = document.querySelector('#download-latest-release');
+        el.innerHTML = stable.name;
+        el.href = stable.html_url;
+        document.querySelector('#release').style.display = 'block';
+        for (let asset of stable.assets) {
+            console.log(asset.name);
+            if (asset.name == 'px4fmu-v4_default.px4') {
+                document.querySelector('#firmware-pixracer').href = asset.browser_download_url;
+            } else if (asset.name == 'px4fmu-v2_lpe.px4') {
+                document.querySelector('#firmware-pixhawk').href = asset.browser_download_url;
+            }
+        }
+    });
+</script>

 QGroundControl
 ---
@@ -25,7 +55,21 @@ QGroundControl

 > **Warning** Не отключайте USB-кабель до окончания процесса прошивки.

-TODO: Иллюстрация.
+<!-- TODO: Иллюстрация. -->
+
+Варианты прошивок
+---
+
+В названии файла прошивки кодируется информации о целевой плате и варианте сборки. Примеры:
+
+* `px4fmu-v4_default.px4` — прошивка для Pixracer с EKF2 и LPE (**Клевер 3** / **Клевер 4**).
+* `px4fmu-v2_lpe.px4` — прошивка для Pixhawk с LPE (**Клевер 2**).
+* `px4fmu-v2_default.px4` — прошивка для Pixhawk с EKF2.
+* `px4fmu-v3_default.px4` — прошивка для более новых версий Pixhawk (чип ревизии 3, см. илл. + Bootloader v5) с EKF2 и LPE.
+
+![STM revision](../assets/stmrev.jpg)
+
+> **Note** Для загрузки `px4fmu-v3_default.px4` может понадобиться использование команды `force_upload` из командной строки.

 Командная строка
 ---
--- a/docs/ru/optical_flow.md
+++ b/docs/ru/optical_flow.md
@@ -4,18 +4,7 @@

 ## Включение

-> **Note** Для использования Optical Flow необходима <a id="download-firmware" href="https://github.com/CopterExpress/Firmware/releases">кастомная прошивка PX4</a>. Подробнее про прошивку см. [соответствующую статью](firmware.md).
-
-<script type="text/javascript">
-    fetch('https://api.github.com/repos/CopterExpress/Firmware/releases').then(res => res.json()).then(function(data) {
-        for (let release of data) {
-            if (!release.prerelease && !release.draft && release.tag_name.includes('-clever.')) {
-                document.querySelector('#download-firmware').href = release.html_url;
-                return;
-            }
-        }
-    });
-</script>
+> **Hint** Рекомендуется использование [специальной сборки PX4 для Клевера](firmware.md#прошивка-для-клевера).

 Необходимо использование дальномера. [Подключите и настройте дальномер VL53L1X](laser.md), используя инструкцию.

--- a/docs/ru/raspberry.md
+++ b/docs/ru/raspberry.md
@@ -1,7 +1,7 @@
 Raspberry Pi
 ============

-**Raspberry Pi** – это свободно помещающийся на ладони одноплатный компьютер, созданный на базе мобильного микропроцессора ARM11. У него низкое потребление энергии, и он может работать даже от солнечных батарей. Raspberry Pi 3 входит в комплект программируемого квадрокоптера "Клевер 2" и "Клевер 3".
+**Raspberry Pi** – это свободно помещающийся на ладони одноплатный компьютер, созданный на базе мобильного микропроцессора ARM11. У него низкое потребление энергии, и он может работать даже от солнечных батарей. Raspberry Pi 3 входит в комплект программируемого квадрокоптера "Клевер 2", "Клевер 3" и "Клевер 4".

 <img src="../assets/raspberry3.jpg" width="500">

--- a/docs/ru/setup.md
+++ b/docs/ru/setup.md
@@ -21,12 +21,14 @@

 ![Обновление прошивки](../assets/firmwarePX4.jpg)

+> **Hint** Рекомендуется использование [специальной сборки PX4 для Клевера](firmware.md#прошивка-для-клевера).
+
 1. Заходим в Vehicle Setup.
 2. Выбираем Firmware.
 3. Отключаем Pixhawk от USB. Подключаем Pixhawk к USB снова.
 4. Ждем подключения Pixhawk,  выбираем прошивку PX4 Flight Stack и активируем Advanced settings.
-5. Выбираем тип прошивки Standard Version (stable). Если загружать собственную прошивку/ прошивку внешним файлом (например, скачанную из интернета), то выбираем Customize из выпадающего меню.
-6. Кликаем OK. Ждем загрузку.
+5. Выбираем тип прошивки Standard Version (stable). Для выбора [кастомной прошивки для Клевера](firmware.md#прошивка-для-клевера) выберите Customize из выпадающего меню.
+6. Кликаем OK. Ждем загрузку или выбираем файл прошивки.
 7. Ждем, пока Pixhawk выполнит перезагрузку.

 ## Настройка Pixhawk
--- a/docs/ru/simple_offboard.md
+++ b/docs/ru/simple_offboard.md
@@ -1,13 +1,17 @@
-Simple OFFBOARD
+Автономный полет (OFFBOARD)
 ===

 > **Note** Документация для версий [образа](microsd_images.md), начиная с **0.15**. Для более ранних версий см. [документацию для версии **0.14**](https://github.com/CopterExpress/clever/blob/v0.14/docs/ru/simple_offboard.md).

-Модуль `simple_offboard` пакета `clever` предназначен для упрощенного программирования автономного дрона ([режим](modes.md) `OFFBOARD`). Он позволяет устанавливать желаемые полетные  задачи и автоматически трансформирует [систему координат](frames.md).
+<!-- -->
+
+> **Hint** Для автономных полетов рекомендуется использование [специальной сборки PX4 для Клевера](firmware.md#прошивка-для-клевера).
+
+Модуль `simple_offboard` пакета `clever` предназначен для упрощенного программирования автономного полета дрона ([режим](modes.md) `OFFBOARD`). Он позволяет устанавливать желаемые полетные задачи и автоматически трансформирует [систему координат](frames.md).

 `simple_offboard` является высокоуровневым способом взаимодействия с полетным контроллером. Для более низкоуровневой работы см. [mavros](mavros.md).

-Основные сервисы – `get_telemetry` (получение всей телеметрии), `navigate` (полет в заданную точку по прямой), `navigate_global` (полет в глобальную точку по прямой), `land` (переход в режим посадки).
+Основные сервисы – [`get_telemetry`](#gettelemetry) (получение телеметрии), [`navigate`](#navigate) (полет в заданную точку по прямой), [`navigate_global`](#navigateglobal) (полет в глобальную точку по прямой), [`land`](#land) (переход в режим посадки).

 Использование из языка Python
 ---