From ef8e1c047861c30e9bd3cfd9718b37d675219663 Mon Sep 17 00:00:00 2001 From: Oleg Kalachev Date: Wed, 30 May 2018 16:04:14 +0300 Subject: [PATCH] docs: some styling --- docs/simple_offboard.md | 52 ++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/simple_offboard.md b/docs/simple_offboard.md index 528a6c61..deb779b0 100644 --- a/docs/simple_offboard.md +++ b/docs/simple_offboard.md @@ -14,9 +14,9 @@ Simple offboard * `auto_arm` = `true`/`false` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**) * `frame_id` — система координат в TF2, в которой заданы координаты и рысканье (yaw), [описание систем координат](frames.md); * `update_frame` — считать ли систему координат изменяющейся (например, `false` для `local_origin`, `fcu`, `fcu_horiz`, `true` для `marker_map`); -* `x`, `y` – горизонтальные координаты в системе координат `frame_id`; -* `z` — высота в системе координат `frame_id`; -* `lat`, `lon` – широта и долгота (в градусах); +* `x`, `y` – горизонтальные координаты в системе координат `frame_id` *(м)*; +* `z` — высота в системе координат `frame_id` *(м)*; +* `lat`, `lon` – широта и долгота *(градусы)*; * `yaw` — рысканье в радианах в системе координат `frame_id` (0 – коптер смотрит по оси X); * `yaw_rate` — угловая скорость по рысканью в радианах в секунду (против часовой), `yaw` должен быть установлен в NaN; * `thrust` — уровень газа от 0 (нет газа) до 1 (полный газ). @@ -69,17 +69,17 @@ release = rospy.ServiceProxy('release', Trigger) * `connected` – есть ли подключение к FCU; * `armed` – состояние `armed` винтов (винты включены, если true); * `mode` - текущий [полетный режим](modes.md); -* `x, y, z` – локальная позиция коптера (м); -* `lat, lon` – широта, долгота (градусы), необходимо наличие [gps](gps.md)); -* `vx, vy, vz` – скорость коптера (м/с); -* `pitch` – угол по тангажу (радианы); -* `roll` – угол по крену (радианы); +* `x, y, z` – локальная позиция коптера *(м)*; +* `lat, lon` – широта, долгота *(градусы)*, необходимо наличие [gps](gps.md)); +* `vx, vy, vz` – скорость коптера *(м/с)*; +* `pitch` – угол по тангажу *(радианы)*; +* `roll` – угол по крену *(радианы)*; * `yaw` – угол по рысканью в фрейме `frame_id`; -* `pitch_rate` – угловая скорость по тангажу (рад/с); -* `roll_rate` – угловая скорость по крену (рад/с); -* `yaw_rate` – угловая скорость по рысканью (рад/с); -* `voltage` – общее напряжение аккумулятора (В); -* `cell_voltage` – напряжение аккумулятора на ячейку (В). +* `pitch_rate` – угловая скорость по тангажу *(рад/с)*; +* `roll_rate` – угловая скорость по крену *(рад/с)*; +* `yaw_rate` – угловая скорость по рысканью *(рад/с)*; +* `voltage` – общее напряжение аккумулятора *(В)*; +* `cell_voltage` – напряжение аккумулятора на ячейку *(В)*. > **Note** Недоступные по каким-то причинам поля будут содержать в себе значения `NaN`. @@ -182,11 +182,11 @@ rosservice call /navigate "{x: 0.0, y: 0.0, z: 2, yaw: 0.0, yaw_rate: 0.0, speed Параметры: -* `lat`, `lon` – широта и долгота (градусы); -* `z` – высота в системе координат `frame_id` (м); -* `yaw` – угол по рысканью (радианы); -* `yaw_rate` – угловая скорость по рысканью (при установке yaw в `NaN`) (рад/с); -* `speed` – скорость полета (скорость движения setpoint) (м/с); +* `lat`, `lon` – широта и долгота *(градусы)*; +* `z` – высота в системе координат `frame_id` *(м)*; +* `yaw` – угол по рысканью *(радианы)*; +* `yaw_rate` – угловая скорость по рысканью (при установке yaw в `NaN`) *(рад/с)*; +* `speed` – скорость полета (скорость движения setpoint) *(м/с)*; * `auto_arm` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**); * `frame_id`, `update_frame`. @@ -218,9 +218,9 @@ rosservice call /navigate_global "{lat: 55.707033, lon: 37.725010, z: 0.0, yaw: Параметры: -* `x`, `y`, `z` – координаты точки в системе координат `frame_id` (м); -* `yaw` – угол по рысканью (радианы); -* `yaw_rate` – угловая скорость по рысканью (при установке yaw в NaN) (рад/с); +* `x`, `y`, `z` – координаты точки в системе координат `frame_id` *(м)*; +* `yaw` – угол по рысканью *(радианы)*; +* `yaw_rate` – угловая скорость по рысканью (при установке yaw в NaN) *(рад/с)*; * `auto_arm` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**); * `frame_id`, `update_frame`. @@ -252,9 +252,9 @@ set_position(x=0, y=0, z=0, frame_id='fcu_horiz', yaw=float('nan'), yaw_rate=0.5 Установить скорости и рысканье. -* `vx`, `vy`, `vz` – требуемая скорость полета (м/с); -* `yaw` – угол по рысканью (радианы); -* `yaw_rate` – угловая скорость по рысканью (при установке yaw в NaN) (рад/с); +* `vx`, `vy`, `vz` – требуемая скорость полета *(м/с)*; +* `yaw` – угол по рысканью *(радианы)*; +* `yaw_rate` – угловая скорость по рысканью (при установке yaw в NaN) *(рад/с)*; * `auto_arm` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**); * `frame_id`, `update_frame`. @@ -280,7 +280,7 @@ set_velocity(vx=0.4, vy=0.0, vz=0, yaw=float('nan'), yaw_rate=0.4, frame_id='fcu Параметры: -* `pitch`, `roll`, `yaw` – необходимый угол по тангажу, крену и рысканью (радианы); +* `pitch`, `roll`, `yaw` – необходимый угол по тангажу, крену и рысканью *(радианы)*; * `thrust` – уровень газа от 0 (нет газа) до 1 (полный газ); * `auto_arm` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**); * `frame_id`, `update_frame`. @@ -291,7 +291,7 @@ set_velocity(vx=0.4, vy=0.0, vz=0, yaw=float('nan'), yaw_rate=0.4, frame_id='fcu Параметры: -* `pitch_rate`, `roll_rate`, `yaw_rate` – угловая скорость по танажу, крену и рыканью (рад/с); +* `pitch_rate`, `roll_rate`, `yaw_rate` – угловая скорость по танажу, крену и рыканью *(рад/с)*; * `thrust` – уровень газа от 0 (нет газа) до 1 (полный газ). * `auto_arm` – перевести коптер в `OFFBOARD` и заармить автоматически (**коптер взлетит, если находится на полу!**);