From d31bd75d7d782ba6f9c4dd81ec67d21bc49d4d85 Mon Sep 17 00:00:00 2001 From: Oleg Kalachev Date: Tue, 1 Feb 2022 13:57:20 +0300 Subject: [PATCH] docs: remove obsolete notes and simplify titles in autonomous flight article --- docs/en/simple_offboard.md | 24 ++++-------------------- docs/ru/simple_offboard.md | 24 ++++-------------------- 2 files changed, 8 insertions(+), 40 deletions(-) diff --git a/docs/en/simple_offboard.md b/docs/en/simple_offboard.md index afe78b26..832bd363 100644 --- a/docs/en/simple_offboard.md +++ b/docs/en/simple_offboard.md @@ -1,11 +1,4 @@ -Autonomous flight (OFFBOARD) -=== - -> **Note** In the image version **0.20** `clever` package was renamed to `clover`. See [previous version of the article](https://github.com/CopterExpress/clover/blob/v0.19/docs/en/simple_offboard.md) for older images. - - - -> **Hint** We recommend using our [custom PX4 firmware for Clover](firmware.md#modified-firmware-for-clover) for autonomous flights. +# Autonomous flight The `simple_offboard` module of the `clover` package is intended for simplified programming of the autonomous drone flight (`OFFBOARD` [flight mode](modes.md)). It allows setting the desired flight tasks, and automatically transforms [coordinates between frames](frames.md). @@ -13,8 +6,7 @@ The `simple_offboard` module of the `clover` package is intended for simplified Main services are [`get_telemetry`](#gettelemetry) (receive telemetry data), [`navigate`](#navigate) (fly to a given point along a straight line), [`navigate_global`](#navigateglobal) (fly to a point specified as latitude and longitude along a straight line), [`land`](#land) (switch to landing mode). -Python examples ---- +## Python usage You need to create proxies for services before calling them. Use the following template for your programs: @@ -37,8 +29,7 @@ land = rospy.ServiceProxy('land', Trigger) Unused proxy functions may be removed from the code. -API description ---- +## API description > **Note** Omitted numeric parameters are set to 0. @@ -314,14 +305,7 @@ rosservice call /land "{}" > **Caution** In recent PX4 versions, the vehicle will be switched out of LAND mode to manual mode, if the remote control sticks are moved significantly. - - -Additional materials ------------------------- +## Additional materials * [ArUco-based position estimation and navigation](aruco.md). * [Program samples and snippets](snippets.md). diff --git a/docs/ru/simple_offboard.md b/docs/ru/simple_offboard.md index 2524eb5a..6e73f3e1 100644 --- a/docs/ru/simple_offboard.md +++ b/docs/ru/simple_offboard.md @@ -1,11 +1,4 @@ -Автономный полет (OFFBOARD) -=== - -> **Note** В версии образа **0.20** пакет `clever` был переименован в `clover`. Для более ранних версий см. документацию для версии [**0.19**](https://github.com/CopterExpress/clover/blob/v0.19/docs/ru/simple_offboard.md). - - - -> **Hint** Для автономных полетов рекомендуется использование [специальной сборки PX4 для Клевера](firmware.md#прошивка-для-клевера). +# Автономный полет Модуль `simple_offboard` пакета `clover` предназначен для упрощенного программирования автономного полета дрона ([режим](modes.md) `OFFBOARD`). Он позволяет устанавливать желаемые полетные задачи и автоматически трансформирует [систему координат](frames.md). @@ -13,8 +6,7 @@ Основные сервисы – [`get_telemetry`](#gettelemetry) (получение телеметрии), [`navigate`](#navigate) (полет в заданную точку по прямой), [`navigate_global`](#navigateglobal) (полет в глобальную точку по прямой), [`land`](#land) (переход в режим посадки). -Использование из языка Python ---- +## Использование из языка Python Для использования сервисов, необходимо создать объекты-прокси к ним. Используйте этот шаблон для вашей программы: @@ -37,8 +29,7 @@ land = rospy.ServiceProxy('land', Trigger) Неиспользуемые функции-прокси можно удалить из кода. -Описание API ---- +## Описание API > **Note** Незаполненные числовые параметры устанавливаются в значение 0. @@ -314,14 +305,7 @@ rosservice call /land "{}" > **Caution** В более новых версиях PX4 коптер выйдет из режима LAND в ручной режим, если сильно перемещать стики. - - -Дополнительные материалы ------------------------- +## Дополнительные материалы * [Полеты в поле ArUco-маркеров](aruco.md). * [Примеры программ и сниппеты](snippets.md).