mirror of
https://github.com/CopterExpress/clover.git
synced 2026-05-26 03:37:58 +00:00
docs: fix placeholder links and docs workflow deprecations (#515)
This commit is contained in:
Yinglei Zhu
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@@ -22,7 +22,7 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js
|
||||
uses: actions/setup-node@v1
|
||||
uses: actions/setup-node@v4
|
||||
with: { node-version: '10' }
|
||||
- name: Setup tools
|
||||
run: |
|
||||
@@ -57,7 +57,7 @@ jobs:
|
||||
rm _book/clover_ru.pdf && mv _book/clover_ru_compressed.pdf _book/clover_ru.pdf
|
||||
rm _book/clover_en.pdf && mv _book/clover_en_compressed.pdf _book/clover_en.pdf
|
||||
ls -lah _book/clover*.pdf
|
||||
echo '::set-output name=GITBOOK_PDF_OK::1'
|
||||
echo 'GITBOOK_PDF_OK=1' >> "$GITHUB_OUTPUT"
|
||||
- name: Download older PDFs
|
||||
if: ${{ !steps.generate-pdf.outputs.GITBOOK_PDF_OK }}
|
||||
run: |
|
||||
|
||||
@@ -166,7 +166,7 @@ network={
|
||||
}
|
||||
```
|
||||
|
||||
Inside the config file, general `wpa_supplicant` settings, and the settings for the adapter configuration are specified. The configuration file also contains `network` section with the basic settings of the Wi-Fi network, such as network SSID, password, adapter operating mode. There may be several `network` sections, but only the first valid one is used. For example, if the first section contains a connection to an unavailable network, the adapter will be configured according to a next valid section, if there is one. Read more about the syntax of `wpa_supplicant.conf` [TODO WIKI].
|
||||
Inside the config file, general `wpa_supplicant` settings, and the settings for the adapter configuration are specified. The configuration file also contains `network` section with the basic settings of the Wi-Fi network, such as network SSID, password, adapter operating mode. There may be several `network` sections, but only the first valid one is used. For example, if the first section contains a connection to an unavailable network, the adapter will be configured according to a next valid section, if there is one. Read more about the syntax of `wpa_supplicant.conf` in the [Debian manual page](https://manpages.debian.org/buster/wpasupplicant/wpa_supplicant.conf.5.en.html).
|
||||
|
||||
#### wpa_passphrase
|
||||
|
||||
|
||||
@@ -66,11 +66,11 @@ Flying forward for 1m:
|
||||
navigate(x=1.5, frame_id='body')
|
||||
```
|
||||
|
||||
[Navigation using ArUco-markers](aruco_marker.md) and [using VPE] are available when using Optical Flow.
|
||||
[Navigation using ArUco-markers](aruco_marker.md) and [using VPE](aruco_map.md) are available when using Optical Flow.
|
||||
|
||||
## Additional settings
|
||||
|
||||
<!-- TODO: статья по пидам -->
|
||||
For additional background on PID tuning, see the [PID tuning guide](calibratePID.md).
|
||||
|
||||
If the copter has an unstable position, try to increase the *P* coefficient of speed PID controller - parameters are `MPC_XY_VEL_P` and `MPC_Z_VEL_P`.
|
||||
|
||||
|
||||
@@ -51,6 +51,6 @@ The sticks on the screen of the application work just like real sticks. To arm t
|
||||
Malfunctions
|
||||
---
|
||||
|
||||
* If the interface of the transmitter displays a surely incorrect voltage (e.g., > 5 V), check that the value of PX4 parameter `BAT_N_CELLS` matches the actual number of battery cells. If the displayed voltage is still incorrect, calibrate the battery (TODO: link).
|
||||
* If the interface of the transmitter displays a surely incorrect voltage (e.g., > 5 V), check that the value of PX4 parameter `BAT_N_CELLS` matches the actual number of battery cells. If the displayed voltage is still incorrect, calibrate the [power sensor](power.md).
|
||||
|
||||
* If instead of mode PX4, text "DISCONNECTED FROM FCU" is displayed, check [Raspberry Pi connection to Pixhawk](connection.md).
|
||||
|
||||
@@ -118,7 +118,7 @@ Press the *Save* button to save the changed value to the flight controller. Chan
|
||||
* `MC_ROLLRATE_I` = 0.050
|
||||
* `MC_ROLLRATE_D` = 0.0025
|
||||
|
||||
> **Hint** Note that you should fine-tune the PID parameters for each drone individually. <!-- TODO: add PID article link -->
|
||||
> **Hint** Note that you should fine-tune the PID parameters for each drone individually. See the [PID tuning guide](calibratePID.md).
|
||||
|
||||
#### Circuit breaker parameters
|
||||
|
||||
|
||||
@@ -146,7 +146,7 @@ navigate(frame_id='aruco_5', x=0, y=0, z=1)
|
||||
|
||||
## Дополнительные настройки
|
||||
|
||||
<!-- TODO: статья по пидам -->
|
||||
Дополнительную информацию по настройке PID см. в статье [Настройка коэффициентов PID](calibratePID.md).
|
||||
|
||||
Если коптер нестабильно удерживает позицию по VPE, попробуйте увеличить коэффициенты *P* PID-регулятора по скорости – параметры `MPC_XY_VEL_P` и `MPC_Z_VEL_P`.
|
||||
|
||||
|
||||
@@ -166,7 +166,7 @@ network={
|
||||
}
|
||||
```
|
||||
|
||||
Внутри конфига указываются общие настройки `wpa_supplicant` и параметры для настройки адаптера. Также конфигурационный файл содержит секции `network` – основные настройки Wi-Fi сети такие как SSID сети, пароль, режим работы адаптера. Таких блоков может быть несколько, но используется первый рабочий. Например, если вы указали в первом блоке подключение к некоторой недоступной сети, то адаптер будет настроен следующей удачной секцией, если такая есть. Подробнее о синтаксисе `wpa_supplicant.conf` [TODO WIKI].
|
||||
Внутри конфига указываются общие настройки `wpa_supplicant` и параметры для настройки адаптера. Также конфигурационный файл содержит секции `network` – основные настройки Wi-Fi сети такие как SSID сети, пароль, режим работы адаптера. Таких блоков может быть несколько, но используется первый рабочий. Например, если вы указали в первом блоке подключение к некоторой недоступной сети, то адаптер будет настроен следующей удачной секцией, если такая есть. Подробнее о синтаксисе `wpa_supplicant.conf` см. в [man-странице Debian](https://manpages.debian.org/buster/wpasupplicant/wpa_supplicant.conf.5.en.html).
|
||||
|
||||
#### wpa_passphrase
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ navigate(x=-1, frame_id='navigate_target')
|
||||
|
||||
## Дополнительные настройки
|
||||
|
||||
<!-- TODO: статья по пидам -->
|
||||
Дополнительную информацию по настройке PID см. в статье [Настройка коэффициентов PID](calibratePID.md).
|
||||
|
||||
Если коптер нестабильно удерживает позицию, попробуйте увеличить коэффициенты *P* PID-регулятора по скорости – параметры `MPC_XY_VEL_P` и `MPC_Z_VEL_P`.
|
||||
|
||||
|
||||
@@ -51,6 +51,6 @@ sudo systemctl restart clover
|
||||
Неисправности
|
||||
---
|
||||
|
||||
* Если интерфейс пульта отображает явно неправильное напряжение (напр. > 5 V), проверьте, что значение PX4-параметра `BAT_N_CELLS` соответствует реальному количество элементов батареи. Если отображаемое напряжение все равно неверно, откалибруйте батарею (TODO: ссылка).
|
||||
* Если интерфейс пульта отображает явно неправильное напряжение (напр. > 5 V), проверьте, что значение PX4-параметра `BAT_N_CELLS` соответствует реальному количеству элементов батареи. Если отображаемое напряжение все равно неверно, откалибруйте [датчик питания](power.md).
|
||||
|
||||
* Если вместо режима PX4 отображается текст "DISCONNECTED FROM FCU", проверьте [подключение Raspberry Pi к Pixhawk](connection.md).
|
||||
|
||||
Reference in New Issue
Block a user